route.js

Route Handlersを使用すると、WebのRequest APIとResponse APIを使用して、指定したルートのカスタムリクエストハンドラーを作成できます。

export async function GET() {
  return Response.json({ message: 'Hello World' })
}

リファレンス

HTTPメソッド

routeファイルを使用すると、指定されたルートのカスタムリクエストハンドラーを作成できます。以下のHTTPメソッドがサポートされています: GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS。

export async function GET(request: Request) {}
 
export async function HEAD(request: Request) {}
 
export async function POST(request: Request) {}
 
export async function PUT(request: Request) {}
 
export async function DELETE(request: Request) {}
 
export async function PATCH(request: Request) {}
 
// If `OPTIONS` is not defined, Next.js will automatically implement `OPTIONS` and set the appropriate Response `Allow` header depending on the other methods defined in the Route Handler.
export async function OPTIONS(request: Request) {}

Parameters

`request` (オプション)

requestオブジェクトはNextRequestオブジェクトであり、WebのRequest APIの拡張です。NextRequestは、cookiesへの簡単なアクセスや、拡張された解析済みURLオブジェクトnextUrlなど、受信リクエストに対するさらなる制御を提供します。

import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const url = request.nextUrl
}

`context` (オプション)

params: 現在のルートの動的ルートパラメータを含むオブジェクトに解決されるPromise。

export async function GET(
  request: Request,
  { params }: { params: Promise<{ team: string }> }
) {
  const { team } = await params
}

例	URL	`params`
`app/dashboard/[team]/route.js`	`/dashboard/1`	`Promise<{ team: '1' }>`
`app/shop/[tag]/[item]/route.js`	`/shop/1/2`	`Promise<{ tag: '1', item: '2' }>`
`app/blog/[...slug]/route.js`	`/blog/1/2`	`Promise<{ slug: ['1', '2'] }>`

ルートコンテキストヘルパー

ルートリテラルのparamsから型指定されたparamsを取得するために、Route HandlerコンテキストをRouteContextで型付けできます。RouteContextはグローバルに利用可能なヘルパーです。

import type { NextRequest } from 'next/server'
 
export async function GET(_req: NextRequest, ctx: RouteContext<'/users/[id]'>) {
  const { id } = await ctx.params
  return Response.json({ id })
}

知っておくと良いこと

型は next dev、next build、または next typegen の実行中に生成されます。

型生成後、RouteContextヘルパーはグローバルに利用可能になります。インポートする必要はありません。

例

Cookie

next/headersからcookiesを使用してCookieの読み取りまたは設定ができます。

import { cookies } from 'next/headers'
 
export async function GET(request: NextRequest) {
  const cookieStore = await cookies()
 
  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

または、Set-Cookieヘッダーを使用して新しいResponseを返すことができます。

import { cookies } from 'next/headers'
 
export async function GET(request: Request) {
  const cookieStore = await cookies()
  const token = cookieStore.get('token')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token.value}` },
  })
}

リクエスト（NextRequest）からCookieを読み取るために、基盤となるWeb APIを使用することもできます。

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

ヘッダー

next/headersからheadersを使用してヘッダーを読み取ることができます。

import { headers } from 'next/headers'
import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const headersList = await headers()
  const referer = headersList.get('referer')
}

このheadersインスタンスは読み取り専用です。ヘッダーを設定するには、新しいheadersを持つ新しいResponseを返す必要があります。

import { headers } from 'next/headers'
 
export async function GET(request: Request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

リクエスト（NextRequest）からヘッダーを読み取るために、基盤となるWeb APIを使用することもできます。

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

キャッシュされたデータの再検証

revalidateルートセグメント設定オプションを使用して、キャッシュされたデータを再検証できます。

export const revalidate = 60
 
export async function GET() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()
 
  return Response.json(posts)
}

リダイレクト

import { redirect } from 'next/navigation'
 
export async function GET(request: Request) {
  redirect('https://nextjs.dokyumento.jp/')
}

動的ルートセグメント

Route Handlersは、動的データからリクエストハンドラーを作成するために動的セグメントを使用できます。

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a', 'b', or 'c'
}

Route	URL例	`params`
`app/items/[slug]/route.js`	`/items/a`	`Promise<{ slug: 'a' }>`
`app/items/[slug]/route.js`	`/items/b`	`Promise<{ slug: 'b' }>`
`app/items/[slug]/route.js`	`/items/c`	`Promise<{ slug: 'c' }>`

URLクエリパラメータ

Route Handlerに渡されるリクエストオブジェクトはNextRequestインスタンスであり、クエリパラメータの処理を容易にするメソッドなど、いくつかの追加の便利なメソッドが含まれています。

import { type NextRequest } from 'next/server'
 
export function GET(request: NextRequest) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query is "hello" for /api/search?query=hello
}

ストリーミング

ストリーミングは、AI生成コンテンツのために、OpenAIなどの大規模言語モデル（LLM）と組み合わせてよく使用されます。AI SDKの詳細についてはこちらをご覧ください。

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'
 
export async function POST(req: Request) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })
 
  return new StreamingTextResponse(result.toAIStream())
}

これらの抽象化は、Web APIを使用してストリームを作成します。基盤となるWeb APIを直接使用することもできます。

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator: any) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()
 
      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}
 
function sleep(time: number) {
  return new Promise((resolve) => {
    setTimeout(resolve, time)
  })
}
 
const encoder = new TextEncoder()
 
async function* makeIterator() {
  yield encoder.encode('<p>One</p>')
  await sleep(200)
  yield encoder.encode('<p>Two</p>')
  await sleep(200)
  yield encoder.encode('<p>Three</p>')
}
 
export async function GET() {
  const iterator = makeIterator()
  const stream = iteratorToStream(iterator)
 
  return new Response(stream)
}

リクエストボディ

標準のWeb APIメソッドを使用してRequestボディを読み取ることができます。

export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

リクエストボディ FormData

request.formData()関数を使用してFormDataを読み取ることができます。

export async function POST(request: Request) {
  const formData = await request.formData()
  const name = formData.get('name')
  const email = formData.get('email')
  return Response.json({ name, email })
}

formDataデータはすべて文字列であるため、リクエストを検証し、好みの形式（例: number）でデータを取得するためにzod-form-dataを使用すると便利です。

CORS

標準のWeb APIメソッドを使用して、特定のRoute HandlerのCORSヘッダーを設定できます。

export async function GET(request: Request) {
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: {
      'Access-Control-Allow-Origin': '*',
      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
      'Access-Control-Allow-Headers': 'Content-Type, Authorization',
    },
  })
}

知っておくと良いこと:

複数のRoute HandlerにCORSヘッダーを追加するには、Proxyまたはnext.config.jsファイルを使用できます。

Webhooks

Route Handlerを使用して、サードパーティサービスからのwebhookを受信できます。

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Process the webhook payload
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

特に、Pages RouterのAPI Routesとは異なり、追加の設定を使用するためにbodyParserを使用する必要はありません。

非UIレスポンス

Route Handlersを使用して、UI以外のコンテンツを返すことができます。sitemap.xml、robots.txt、app icons、およびopen graph imagesはすべて組み込みサポートがあります。

export async function GET() {
  return new Response(
    `<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0">
 
<channel>
  <title>Next.js Documentation</title>
  <link>https://nextjs.dokyumento.jp/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

セグメント設定オプション

Route Handlersは、ページやレイアウトと同じルートセグメント設定を使用します。

export const dynamic = 'auto'
export const dynamicParams = true
export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'

詳細については、APIリファレンスを参照してください。

バージョン履歴

バージョン	変更履歴
`v15.0.0-RC`	`context.params`はPromiseになりました。利用可能なcodemodがあります。
`v15.0.0-RC`	`GET`ハンドラーのデフォルトのキャッシングが静的から動的に変更されました。
`v13.2.0`	Route Handlersが導入されました。