ルートハンドラー

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

補足: ルートハンドラーは app ディレクトリ内でのみ利用可能です。これは pages ディレクトリ内の API Routes と同等の機能であり、API Routes とルートハンドラーを一緒に使用する必要はありません。

規約

ルートハンドラーは app ディレクトリ内の route.js|ts ファイルで定義します：

app/api/route.ts

export async function GET(request: Request) {}

app/api/route.js

export async function GET(request) {}

ルートハンドラーは page.js や layout.js と同様に、app ディレクトリ内のどこにでも入れ子にできます。ただし、page.js と同じルートセグメントレベルに route.js ファイルを配置することはできません。

サポートされる HTTP メソッド

以下の HTTP メソッドがサポートされています：GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS。サポートされていないメソッドが呼び出された場合、Next.js は 405 Method Not Allowed レスポンスを返します。

拡張された `NextRequest` と `NextResponse` API

ネイティブの Request と Response API をサポートすることに加えて、Next.js は NextRequest と NextResponse を拡張し、高度なユースケースに便利なヘルパーを提供します。

動作

キャッシング

ルートハンドラーはデフォルトではキャッシュされません。ただし、GET メソッドのキャッシュを選択できます。他のサポートされる HTTP メソッドはキャッシュされません。GET メソッドをキャッシュするには、ルートハンドラーファイルで export const dynamic = 'force-static' などのルート設定オプションを使用します。

app/items/route.ts

export const dynamic = 'force-static'
 
export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const data = await res.json()
 
  return Response.json({ data })
}

app/items/route.js

export const dynamic = 'force-static'
 
export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const data = await res.json()
 
  return Response.json({ data })
}

補足: 他のサポートされる HTTP メソッドは、同じファイル内でキャッシュされる GET メソッドと並んでいても、キャッシュされません。

特殊なルートハンドラー

sitemap.ts、opengraph-image.tsx、icon.tsx、その他のメタデータファイルなどの特殊なルートハンドラーは、動的 API や動的設定オプションを使用しない限り、デフォルトで静的のままです。

ルート解決

route は、最も低レベルのルーティングプリミティブと考えることができます。

レイアウトやクライアント側のナビゲーションに参加しません（page とは異なります）。
page.js と同じルートに route.js ファイルを配置することはできません。

ページ	ルート	結果
`app/page.js`	`app/route.js`	競合
`app/page.js`	`app/api/route.js`	有効
`app/[user]/page.js`	`app/api/route.js`	有効

各 route.js または page.js ファイルは、そのルートのすべての HTTP 動詞を引き受けます。

app/page.js

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}
 
// ❌ 競合
// `app/route.js`
export async function POST(request) {}

例

以下の例は、ルートハンドラーを他の Next.js の API や機能と組み合わせる方法を示しています。

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

増分静的再生成（Incremental Static Regeneration、ISR）を使用して、キャッシュされたデータを再検証できます：

app/posts/route.ts

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)
}

app/posts/route.js

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)
}

クッキー

next/headers の cookies を使用して、クッキーを読み取りまたは設定できます。このサーバー関数は、ルートハンドラーで直接呼び出すか、別の関数内でネストできます。

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

app/api/route.ts

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}` },
  })
}

app/api/route.js

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

基盤となる Web API を使用して、リクエストからクッキーを読み取ることもできます（NextRequest）：

app/api/route.ts

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

app/api/route.js

export async function GET(request) {
  const token = request.cookies.get('token')
}

ヘッダー

next/headers の headers を使用してヘッダーを読み取ることができます。このサーバー関数は、ルートハンドラーで直接呼び出すか、別の関数内でネストできます。

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

app/api/route.ts

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 },
  })
}

app/api/route.js

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

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

app/api/route.ts

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

app/api/route.js

export async function GET(request) {
  const requestHeaders = new Headers(request.headers)
}

リダイレクト

app/api/route.ts

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

app/api/route.js

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

動的ルートセグメント

続ける前に、ルート定義のページを読むことをお勧めします。

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

app/items/[slug]/route.ts

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

app/items/[slug]/route.js

export async function GET(request, { params }) {
  const slug = (await params).slug // 'a'、'b'、または 'c'
}

ルート	例の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インスタンスで、クエリパラメータを簡単に処理できます。

app/api/search/route.ts

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

app/api/search/route.js

export function GET(request) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query は /api/search?query=hello の場合 "hello"
}

ストリーミング

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

app/api/chat/route.ts

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())
}

app/api/chat/route.js

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

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

app/api/route.ts

// 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)
}

app/api/route.js

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()
 
      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}
 
function sleep(time) {
  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のボディを読み取ることができます：

app/items/route.ts

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

app/items/route.js

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

リクエストボディ FormData

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

app/items/route.ts

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 })
}

app/items/route.js

export async function POST(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ヘッダーを設定できます：

app/api/route.ts

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',
    },
  })
}

app/api/route.js

export async function GET(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ヘッダーを追加するには、ミドルウェアまたはnext.config.jsファイルを使用できます。

別の方法として、CORSの例パッケージもご覧ください。

Webhooks

サードパーティサービスからのWebhookを受信するためにRoute Handlerを使用できます：

app/api/route.ts

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Webhookペイロードを処理
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

app/api/route.js

export async function POST(request) {
  try {
    const text = await request.text()
    // Webhookペイロードを処理
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

特筆すべきは、PagesルーターのAPIルートとは異なり、追加の設定を使用するためにbodyParserを使用する必要がないことです。

非UI レスポンス

Route Handlersを使用して、UI以外のコンテンツを返すことができます。sitemap.xml、robots.txt、アプリアイコン、オープングラフ画像はすべて組み込みのサポートがあることに注意してください。

app/rss.xml/route.ts

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

app/rss.xml/route.js

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`)
}

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

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

app/items/route.ts

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

app/items/route.js

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リファレンスを参照してください。

ルートハンドラー

API リファレンス

route.js