ルートハンドラー

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

重要事項: ルートハンドラーは、app ディレクトリ内でのみ使用できます。これらは、pages ディレクトリ内の API ルートと同等であり、API ルートとルートハンドラーを同時に使用する必要はありません。

規約

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

app/api/route.ts

export async function GET(request: 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 })
}

重要な情報: その他のサポートされている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>
}
 
// ❌ Conflict
// `app/route.js`
export async function POST(request) {}

例

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

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

インクリメンタルスタティックリジェネレーション（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)
}

クッキー

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

また、基盤となる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')
}

ヘッダー

next/headersの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 },
  })
}

また、基盤となる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.ts

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

動的ルートセグメント

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

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

app/items/[slug]/route.ts

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

ルート	例URL	`パラメーター`
`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クエリパラメーター

ルートハンドラーに渡されるリクエストオブジェクトは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 is "hello" for /api/search?query=hello
}

ストリーミング

ストリーミングは、OpenAIなどの大規模言語モデル（LLM）と組み合わせて、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())
}

これらの抽象化は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)
}

リクエストボディ

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

app/items/route.ts

export async function POST(request: 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 })
}

formData のデータはすべて文字列であるため、zod-form-data を使用してリクエストを検証し、必要な形式（例：number）でデータを取得することをお勧めします。

CORS

標準的なWeb APIメソッドを使用して、特定のルートハンドラーに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',
    },
  })
}

知っておくと良い点:

複数のルートハンドラーにCORSヘッダーを追加するには、ミドルウェアまたはnext.config.jsファイルを使用できます。

あるいは、CORSの例パッケージを参照してください。

Webhooks

サードパーティサービスからのWebhooksを受信するために、ルートハンドラーを使用できます。

app/api/route.ts

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

特に、ページルーターを使用したAPIルートとは異なり、追加の設定を使用するためにbodyParserを使用する必要はありません。

UI以外のレスポンス

ルートハンドラーを使用して、UI以外のコンテンツを返すことができます。sitemap.xml、robots.txt、アプリアイコン、およびOpen Graph画像はすべて、組み込みでサポートされています。

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

セグメント構成オプション

ルートハンドラーは、ページとレイアウトと同じルートセグメント構成を使用します。

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'

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

ルートハンドラー

API リファレンス

route.js