NextResponse

NextResponse는 추가 편의 메서드와 함께 Web Response API (opens in a new tab)를 확장합니다.

`cookies`

응답의 Set-Cookie (opens in a new tab) 헤더를 읽거나 수정합니다.

`set(name, value)`

주어진 이름으로 응답에 주어진 값의 쿠키를 설정합니다.

// /home 요청이 주어졌을 때
let response = NextResponse.next()
// 배너를 숨기기 위한 쿠키 설정
response.cookies.set('show-banner', 'false')
// 응답에는 `Set-Cookie:show-banner=false;path=/home` 헤더가 추가됩니다.
return response

`get(name)`

주어진 쿠키 이름을 기준으로 쿠키의 값을 반환합니다. 쿠키가 발견되지 않으면 undefined를 반환합니다. 여러 개의 쿠키가 발견되면 첫 번째 쿠키만 반환합니다.

// /home 요청이 주어졌을 때
let response = NextResponse.next()
// { name: 'show-banner', value: 'false', Path: '/home' }
response.cookies.get('show-banner')

`getAll()`

주어진 쿠키 이름을 기준으로 쿠키의 값을 반환합니다. 이름이 주어지지 않으면 응답에 있는 모든 쿠키를 반환합니다.

// /home 요청이 주어졌을 때
let response = NextResponse.next()
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
response.cookies.getAll('experiments')
// 또는, 응답에 있는 모든 쿠키를 가져옵니다.
response.cookies.getAll()

`delete(name)`

주어진 쿠키 이름을 기준으로 응답에서 쿠키를 삭제합니다.

// /home 요청이 주어졌을 때
let response = NextResponse.next()
// 삭제된 경우 true를 반환하고, 그렇지 않으면 false를 반환합니다.
response.cookies.delete('experiments')

`json()`

주어진 JSON 본문을 사용하여 응답을 생성합니다.

app/api/route.ts

import { NextResponse } from 'next/server'
 
export async function GET(request: Request) {
  return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
}

app/api/route.js

import { NextResponse } from 'next/server'
 
export async function GET(request) {
  return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
}

`redirect()`

URL (opens in a new tab)로 리디렉션하는 응답을 생성합니다.

import { NextResponse } from 'next/server'
 
return NextResponse.redirect(new URL('/new', request.url))

URL (opens in a new tab)은 NextResponse.redirect() 메서드에서 사용되기 전에 생성되고 수정될 수 있습니다. 예를 들어, request.nextUrl 속성을 사용하여 현재 URL을 가져온 다음, 다른 URL로 리디렉션하도록 수정할 수 있습니다.

import { NextResponse } from 'next/server'
 
// 주어진 요청에 대해...
const loginUrl = new URL('/login', request.url)
// /login URL에 ?from=/incoming-url 추가
loginUrl.searchParams.set('from', request.nextUrl.pathname)
// 새 URL로 리디렉션
return NextResponse.redirect(loginUrl)

`rewrite()`

원래의 URL을 유지하면서 주어진 URL (opens in a new tab)을 재작성(프록시)하는 응답을 생성합니다.

import { NextResponse } from 'next/server'
 
// 들어오는 요청: /about, 브라우저는 /about 표시
// 재작성된 요청: /proxy, 브라우저는 /about 표시
return NextResponse.rewrite(new URL('/proxy', request.url))

`next()`

next() 메서드는 라우팅을 계속하도록 허용하는 미들웨어에서 유용합니다.

import { NextResponse } from 'next/server'
 
return NextResponse.next()

응답을 생성할 때 headers를 전달할 수도 있습니다:

import { NextResponse } from 'next/server'
 
// 주어진 요청에 대해...
const newHeaders = new Headers(request.headers)
// 새 헤더 추가
newHeaders.set('x-version', '123')
// 새 헤더로 응답 생성
return NextResponse.next({
  request: {
    // 새 요청 헤더
    headers: newHeaders,
  },
})

`headers`

응답의 헤더를 설정할 수 있습니다. 이는 HTTP 응답의 헤더를 설정하거나 조작할 때 유용합니다.

import { NextResponse } from 'next/server'
 
const response = NextResponse.next()
// 헤더 설정
response.headers.set('x-custom-header', 'my-value')
return response

import { NextResponse } from 'next/server'
 
const response = NextResponse.next()
// 헤더 가져오기
const headerValue = response.headers.get('x-custom-header')

참고: NextResponse는 추가 메서드와 함께 기본 Web Response API를 확장하므로, 기본 Response API의 모든 메서드도 사용할 수 있습니다.

`status`

응답의 상태 코드를 설정할 수 있습니다. 이는 HTTP 상태 코드를 설정하거나 확인할 때 유용합니다.

import { NextResponse } from 'next/server'
 
const response = NextResponse.next()
// 상태 코드 설정
response.status = 404
return response

import { NextResponse } from 'next/server'
 
const response = NextResponse.next()
// 상태 코드 가져오기
const statusCode = response.status

Version History

Version	Changes
`v13.0.0`	`NextResponse` introduced.

Next Request Not Found