ルートハンドラ

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

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

規約

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

export const dynamic = 'force-dynamic' // デフォルトはauto
export async function GET(request: Request) {}

export const dynamic = 'force-dynamic' // デフォルトはauto
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

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

動作

キャッシュ

ルートハンドラは、GETメソッドとResponseオブジェクトを使用する場合、デフォルトでキャッシュされます。

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

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

TypeScript警告: Response.json()はTypeScript 5.2以降でのみ有効です。それ以前のバージョンでは、型付きレスポンスのためにNextResponse.json()を使用できます。

キャッシュの無効化

以下の方法でキャッシュを無効にできます：

GETメソッドでRequestオブジェクトを使用する
他のHTTPメソッドを使用する
cookiesやheadersなどの動的関数を使用する
セグメント設定オプションで動的モードを手動で指定する

例：

export async function GET(request: Request) {
  const { searchParams } = new URL(request.url)
  const id = searchParams.get('id')
  const res = await fetch(`https://data.mongodb-api.com/product/${id}`, {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
  })
  const product = await res.json()

  return Response.json({ product })
}

export async function GET(request) {
  const { searchParams } = new URL(request.url)
  const id = searchParams.get('id')
  const res = await fetch(`https://data.mongodb-api.com/product/${id}`, {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const product = await res.json()

  return Response.json({ product })
}

同様に、POSTメソッドを使用するとルートハンドラは動的に評価されます。

export async function POST() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
    body: JSON.stringify({ time: new Date().toISOString() }),
  })

  const data = await res.json()

  return Response.json(data)
}

export async function POST() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
    body: JSON.stringify({ time: new Date().toISOString() }),
  })

  const data = await res.json()

  return Response.json(data)
}

補足: APIルートと同様に、ルートハンドラはフォーム送信の処理などのケースで使用できます。Reactと深く統合されたフォームとミューテーションの処理のための新しい抽象化が開発中です。

ルート解決

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や機能と組み合わせる方法を示しています。

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

next.revalidateオプションを使用して、キャッシュデータを再検証できます：

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // 60秒ごとに再検証
  })
  const data = await res.json()

  return Response.json(data)
}

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // 60秒ごとに再検証
  })
  const data = await res.json()

  return Response.json(data)
}

あるいは、revalidateセグメント設定オプションを使用できます：

export const revalidate = 60

動的関数

ルートハンドラは、Next.jsのcookiesやheadersなどの動的関数と一緒に使用できます。

Cookies

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

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

import { cookies } from 'next/headers'

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

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token.value}` },
  })
}

import { cookies } from 'next/headers'

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

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token}` },
  })
}

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

import { type NextRequest } from 'next/server'

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

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

Headers

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

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

import { headers } from 'next/headers'

export async function GET(request: Request) {
  const headersList = headers()
  const referer = headersList.get('referer')

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

import { headers } from 'next/headers'

export async function GET(request) {
  const headersList = 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)
}

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

リダイレクト

import { redirect } from 'next/navigation'

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

import { redirect } from 'next/navigation'

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

動的ルートセグメント

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

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

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

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

ルート	例URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`{ slug: 'a' }`
`app/items/[slug]/route.js`	`/items/b`	`{ slug: 'b' }`
`app/items/[slug]/route.js`	`/items/c`	`{ 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"
}

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

ストリーミング

ストリーミングは、OpenAIなどの大規模言語モデル(LLM)と組み合わせて、AI生成コンテンツに使用されることが一般的です。AI SDKについてさらに学びます。

import OpenAI from 'openai'
import { OpenAIStream, StreamingTextResponse } from 'ai'

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
})

export const runtime = 'edge'

export async function POST(req: Request) {
  const { messages } = await req.json()
  const response = await openai.chat.completions.create({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages,
  })

  const stream = OpenAIStream(response)

  return new StreamingTextResponse(stream)
}

import OpenAI from 'openai'
import { OpenAIStream, StreamingTextResponse } from 'ai'

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
})

export const runtime = 'edge'

export async function POST(req) {
  const { messages } = await req.json()
  const response = await openai.chat.completions.create({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages,
  })

  const stream = OpenAIStream(response)

  return new StreamingTextResponse(stream)
}

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

// 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ボディを読み取ることができます:

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

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

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のデータはすべて文字列なので、zod-form-dataを使用してリクエストを検証し、希望する形式（例: number）でデータを取得することもできます。

CORS

標準的なWeb APIメソッドを使用して、特定のルートハンドラーにCORSヘッダーを設定できます:

export const dynamic = 'force-dynamic' // デフォルトはauto

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

export const dynamic = 'force-dynamic' // デフォルトはauto

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

知っておくと良いこと:

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

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

Webhook

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

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

  return new Response('成功しました！', {
    status: 200,
  })
}

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

  return new Response('成功しました！', {
    status: 200,
  })
}

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

EdgeおよびNode.jsランタイム

ルートハンドラーは、EdgeとNode.jsの両方のランタイムをシームレスにサポートする同型のWeb APIを備えており、ストリーミングもサポートしています。ルートハンドラーは、ページやレイアウトと同じルートセグメント設定を使用するため、一般的な静的再生成ルートハンドラーなどの待望の機能をサポートしています。

runtimeセグメント設定オプションを使用してランタイムを指定できます:

export const runtime = 'edge' // デフォルトは'nodejs'

非UIレスポンス

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

export const dynamic = 'force-dynamic' // デフォルトはauto

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 = 'force-dynamic' // デフォルトはauto

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

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

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

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

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