NextResponse

NextResponse は、便利なメソッドを追加して Web Response API を拡張します。

`cookies`

レスポンスの Set-Cookie ヘッダーを読み書きします。

`set(name, value)`

名前を指定して、レスポンスに指定された値を持つクッキーを設定します。

// Given incoming request /home
let response = NextResponse.next()
// Set a cookie to hide the banner
response.cookies.set('show-banner', 'false')
// Response will have a `Set-Cookie:show-banner=false;path=/home` header
return response

`get(name)`

クッキー名を指定して、クッキーの値を返します。クッキーが見つからない場合は、undefined が返されます。複数のクッキーが見つかった場合は、最初のものが返されます。

// Given incoming request /home
let response = NextResponse.next()
// { name: 'show-banner', value: 'false', Path: '/home' }
response.cookies.get('show-banner')

`getAll()`

クッキー名を指定して、クッキーの値を返します。名前が指定されていない場合は、レスポンスのすべてのクッキーを返します。

// Given incoming request /home
let response = NextResponse.next()
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
response.cookies.getAll('experiments')
// Alternatively, get all cookies for the response
response.cookies.getAll()

`delete(name)`

クッキー名を指定して、レスポンスからクッキーを削除します。

// Given incoming request /home
let response = NextResponse.next()
// Returns true for deleted, false is nothing is deleted
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 })
}

`redirect()`

URLにリダイレクトするレスポンスを生成します。

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

URLは、NextResponse.redirect()メソッドで使用する前に作成および変更できます。たとえば、request.nextUrlプロパティを使用して現在のURLを取得し、それを変更して別のURLにリダイレクトできます。

import { NextResponse } from 'next/server'
 
// Given an incoming request...
const loginUrl = new URL('/login', request.url)
// Add ?from=/incoming-url to the /login URL
loginUrl.searchParams.set('from', request.nextUrl.pathname)
// And redirect to the new URL
return NextResponse.redirect(loginUrl)

`rewrite()`

元のURLを保持しながら、指定されたURLを書き換える（プロキシする）レスポンスを生成します。

import { NextResponse } from 'next/server'
 
// Incoming request: /about, browser shows /about
// Rewritten request: /proxy, browser shows /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'
 
// Given an incoming request...
const newHeaders = new Headers(request.headers)
// Add a new header
newHeaders.set('x-version', '123')
// And produce a response with the new headers
return NextResponse.next({
  request: {
    // New request headers
    headers: newHeaders,
  },
})