ルートハンドラー

ルートハンドラーを使用すると、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.ts

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}
 
// ❌ Conflict
// `app/route.ts`
export async function POST(request: 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)
}

クッキー

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 // 'a', 'b', or '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クエリパラメータ

ルートハンドラーに渡されるリクエストオブジェクトは`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の例パッケージも参照してください。

Webhook

ルートハンドラーを使用して、サードパーティサービスからWebhookを受信できます。

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

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

非UIレスポンス

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

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