Vue Academy · 강의

Nuxt 서버 라우트와 API 엔드포인트

server/api/ 디렉터리, defineEventHandler(), H3 유틸리티, 미들웨어와 오류 처리를 익힙니다.

레슨 3/413개 단계

Nuxt 서버 라우트와 API 엔드포인트은(는) CoddyKit의 무료 Vue Academy 강의입니다. 이것은 4개 중 3번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Vue Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Vue Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

Nuxt는 풀스택입니다

Nuxt 3에는 서버 엔진인 Nitro가 포함되어 있습니다. server/ 디렉터리를 사용하면 별도의 백엔드 없이도 여러 앱에서 페이지와 함께 API 엔드포인트를 구축할 수 있습니다.

server/api 디렉터리

server/api/의 파일은 /api 아래의 API 경로가 됩니다. server/api/hello.ts는 /api/hello에서 응답합니다.

server/
  api/
    hello.ts   ->  /api/hello
    posts.ts   ->  /api/posts

defineEventHandler

모든 서버 경로는 defineEventHandler로 생성한 핸들러를 내보냅니다. 핸들러가 반환하는 값은 자동으로 JSON으로 직렬화되어 응답으로 전송됩니다.

// server/api/hello.ts
export default defineEventHandler((event) => {
  return { message: 'Hello from the server' }
})

HTTP 메서드 접미사

파일 이름에 메서드 접미사를 추가하면 해당 메서드로 제한할 수 있습니다. users.get.ts는 GET을 처리하고, users.post.ts는 POST를 처리합니다. 접미사가 없으면 해당 경로는 모든 메서드에 응답합니다.

server/api/
  users.get.ts   ->  GET /api/users
  users.post.ts  ->  POST /api/users

쿼리 매개변수 읽기

getQuery 도우미를 사용하여 이벤트에서 URL 쿼리 문자열을 읽습니다.

export default defineEventHandler((event) => {
  const query = getQuery(event)
  return { search: query.q }
})

요청 본문 읽기

POST/PUT 요청에서는 readBody가 들어오는 JSON 본문을 파싱합니다. 비동기 함수이므로 await해야 합니다.

export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  return { received: body }
})

동적 서버 경로

대괄호로 된 파일 이름은 서버에서도 작동합니다. server/api/users/[id].get.ts는 getRouterParam을 사용하여 id를 읽습니다.

export default defineEventHandler((event) => {
  const id = getRouterParam(event, 'id')
  return { id }
})

HTTP 오류 발생시키기

일반 오류를 발생시키는 대신 createError를 사용하여 상태 코드와 메시지가 포함된 적절한 HTTP 오류 응답을 반환합니다.

export default defineEventHandler((event) => {
  const id = getRouterParam(event, 'id')
  if (!id) {
    throw createError({ statusCode: 400, statusMessage: 'Missing id' })
  }
})

H3 이벤트 객체

event 인수는 Nitro의 HTTP 프레임워크인 H3에서 전달됩니다. 이 객체에는 요청과 응답이 포함되며, 모든 도우미 함수의 진입점 역할을 합니다.

상태와 헤더 설정하기

setResponseStatus와 setHeader 같은 도우미를 사용하면 값을 반환하는 것만으로 충분하지 않을 때 응답을 제어할 수 있습니다.

export default defineEventHandler((event) => {
  setResponseStatus(event, 201)
  setHeader(event, 'Cache-Control', 'no-cache')
  return { created: true }
})

페이지에서 API 호출하기

페이지에서 useFetch 또는 $fetch를 사용하여 자체 엔드포인트에서 데이터를 가져옵니다. SSR 중에는 Nuxt가 HTTP 왕복 없이 핸들러를 직접 호출합니다.

const { data } = await useFetch('/api/posts')

빠른 확인

Nuxt 서버 경로에 대한 지식을 확인해 보세요.

복습

Nuxt 서버 경로를 배웠습니다:

  • server/api/의 파일은 API 엔드포인트가 됩니다.
  • defineEventHandler는 핸들러를 정의하고, 핸들러의 반환값이 응답이 됩니다.
  • .get.ts/.post.ts 접미사는 HTTP 메서드의 범위를 제한합니다.
  • H3 이벤트에서 getQuery, readBody, getRouterParam, createError를 사용합니다.
무료로 시작

AI 튜터와 함께 HTML을(를) 배우세요 — 무료

브라우저에서 실제 코드를 작성하고 실행하며, 24/7 AI 튜터로부터 즉각적인 도움을 받고, 웹이나 앱에서 중단한 부분부터 계속 학습하세요.

코스
42
레슨
156

자주 묻는 질문

“Nuxt 서버 라우트와 API 엔드포인트” 강의는 무료인가요?

네 — “Nuxt 서버 라우트와 API 엔드포인트” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Vue Academy 강의 전체를 잠금 해제할 수 있습니다. Vue Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“Nuxt 서버 라우트와 API 엔드포인트”에서 뭘 배우나요?

server/api/ 디렉터리, defineEventHandler(), H3 유틸리티, 미들웨어와 오류 처리를 익힙니다. 브라우저에서 직접 실행하는 실습 코드로 Vue Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Vue Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Vue Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 3번째 강의입니다.

“Nuxt 서버 라우트와 API 엔드포인트” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Vue Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Vue Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

  1. Nuxt 3 프로젝트 구조와 파일 기반 라우팅
  2. 데이터 가져오기: useFetch와 useAsyncData
  3. Nuxt 서버 라우트와 API 엔드포인트
  4. SSR, SSG, SPA 모드 비교
← Vue Academy(으)로 돌아가기