logoNext.js 日本語
ドキュメントブログ学習
はじめに/アプリケーションの構築/ルーティング/ルートハンドラ

ルートハンドラ

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

Route.js特別ファイル

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

規約

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

export async function GET(request: Request) {}
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.jsapp/route.jsCross Icon 競合
app/page.jsapp/api/route.jsCheck Icon 有効
app/[user]/page.jsapp/api/route.jsCheck Icon 有効

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

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

ヘッダー

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'
}
ルート例URLparams
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"
}

ストリーミング (Streaming)

ストリーミングは、OpenAIなどの大規模言語モデル (LLM: Large Language Models) と組み合わせて、AI生成コンテンツに使用されることが一般的です。AI SDKの詳細をご覧ください。

import { Configuration, OpenAIApi } from 'openai-edge'
import { OpenAIStream, StreamingTextResponse } from 'ai'

export const runtime = 'edge'

const apiConfig = new Configuration({
  apiKey: process.env.OPENAI_API_KEY!,
})

const openai = new OpenAIApi(apiConfig)

export async function POST(req: Request) {
  // リクエストの本文から`messages`を抽出
  const { messages } = await req.json()

  // プロンプトに基づいてOpenAI APIにレスポンスをリクエスト
  const response = await openai.createChatCompletion({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages: messages,
    max_tokens: 500,
    temperature: 0.7,
    top_p: 1,
    frequency_penalty: 1,
    presence_penalty: 1,
  })

  // レスポンスをフレンドリーなテキストストリームに変換
  const stream = OpenAIStream(response)

  // ストリームでレスポンス
  return new StreamingTextResponse(stream)
}
import { Configuration, OpenAIApi } from 'openai-edge'
import { OpenAIStream, StreamingTextResponse } from 'ai'

export const runtime = 'edge'

const apiConfig = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
})

const openai = new OpenAIApi(apiConfig)

export async function POST(req) {
  // リクエストの本文から`messages`を抽出
  const { messages } = await req.json()

  // プロンプトに基づいてOpenAI APIにレスポンスをリクエスト
  const response = await openai.createChatCompletion({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages: messages,
    max_tokens: 500,
    temperature: 0.7,
    top_p: 1,
    frequency_penalty: 1,
    presence_penalty: 1,
  })

  // レスポンスをフレンドリーなテキストストリームに変換
  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)
}

リクエストボディ (Request Body)

標準の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 })
}

フォームデータのリクエストボディ (Request Body 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メソッドを使用してResponseに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',
    },
  })
}
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',
    },
  })
}

EdgeおよびNode.jsランタイム (Edge and Node.js Runtimes)

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

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

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

非UIレスポンス (Non-UI Responses)

Route Handlersを使用して非UIコンテンツを返すことができます。sitemap.xml、robots.txt、アプリアイコン、Open Graph画像はすべて組み込みでサポートされています。

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

セグメント設定オプション (Segment Config Options)

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

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 リファレンス。

インターセプティングルート

インターセプティングルートを使用すると、現在のレイアウト内で新しいルートを読み込みつつブラウザのURLをマスクできます。モーダルなどの高度なルーティングパターンに有用です。

ミドルウェア

リクエスト完了前にコードを実行するミドルウェアの使用方法を学びます。