ルートハンドラ

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

豆知識: ルートハンドラはappディレクトリ内でのみ利用可能です。これはpagesディレクトリ内のAPIルートと同等の機能を提供するため、APIルートとルートハンドラを同時に使用する必要はありません。

規約

ルートハンドラはappディレクトリ内のroute.js|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

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

動作

キャッシュ

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

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などの特別なルートハンドラやその他のメタデータファイルは、Dynamic 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動詞を引き継ぎます。

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}

// ❌ 競合
// `app/route.ts`
export async function POST(request: Request) {}

例

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

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

インクリメンタル静的再生成（ISR）を使用してキャッシュデータを再検証できます：

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を使用してCookieを読み書きできます。このサーバー関数はルートハンドラで直接呼び出すか、他の関数内にネストできます。

または、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}` },
  })
}

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

import { type NextRequest } from 'next/server'

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

ヘッダー

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

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

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

import { type NextRequest } from 'next/server'

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

リダイレクト

import { redirect } from 'next/navigation'

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

動的ルートセグメント

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

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // '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クエリパラメータ

ルートハンドラに渡されるリクエストオブジェクトはNextRequestインスタンスで、クエリパラメータをより簡単に処理するための便利なメソッドが含まれています。

import { type NextRequest } from 'next/server'

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

ストリーミング

ストリーミングは、OpenAIなどの大規模言語モデル（LLM）と組み合わせて、AI生成コンテンツに使用されることが一般的です。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データはすべて文字列であるため、zod-form-dataを使用してリクエストを検証し、希望する形式（例：number）でデータを取得することが望ましい場合があります。

CORS

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

豆知識:

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

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

Webhook (ウェブフック)

サードパーティサービスからのウェブフックを受信するために、ルートハンドラを使用できます:

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // ウェブフックのペイロードを処理
  } 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、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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

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

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

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

route.js

route.js 特殊ファイルに関する API リファレンス。

route.js

On this page