Route Handlers

Route Handlers を使うと、Web Request と Response API を使って、指定したルートのカスタムリクエストハンドラを作成できます。

Route.js Special File

Good to know: ルートハンドラは app ディレクトリ内でのみ利用可能です。これらは pages ディレクトリ内の API Routes に相当します。つまり、API Routes と Route Handlers を一緒に使う必要はありません。

規約

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

app/api/route.ts
export const dynamic = 'force-dynamic' // defaults to auto
export async function GET(request: Request) {}

ルートハンドラは page.js や layout.js と同じように app ディレクトリの中に入れ子にできます。しかし、page.js と同じルート Segment レベルに route.js ファイルを置くことはできません。

サポートされる HTTP メソッド

以下のHTTP メソッドがサポートされている： GET、POST、PUT、PATCH、DELETE、HEAD および OPTIONS です。サポートされていないメソッドが呼び出された場合、Next.js は 405 Method Not Allowed 応答を返します。

拡張 `NextRequest` と `NextResponse` API

ネイティブのRequestとResponseをサポートしています。Next.js はこれらを次のように拡張します。 NextRequestとNextResponseで拡張し、高度なユースケースのための便利なヘルパーを提供します。

Behavior

キャッシング

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

app/items/route.ts
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 Warning: Response.json()は TypeScript 5.2 以降でのみ有効です。それ以下のバージョンの TypeScript を使用している場合は、代わりに型付きレスポンスの NextResponse.json()を使用することができます。

キャッシュのオプトアウト

キャッシュ無効にするには以下の方法があります：

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

例えば

app/products/api/route.ts
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 })
}

同様に、POSTメソッドは Route Handler を動的に評価します。

app/items/route.ts
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)
}

Good to know: API Routes のように、Route Handlers はフォームの送信を処理するようなケースに使うことができます。React と深く統合された、Server Actionsとミューテーションを処理するための新しい抽象化に取り組んでいます。

Route 解決

ルートは最下層のルーティングプリミティブと考えることができます。

それらは page のようなレイアウトやクライアントサイドのナビゲーションには 参加しません。
page.js と同じルートに route.js ファイルを置くことはできません。

Page	Route	Result
`app/page.js`	`app/route.js`	Conflict
`app/page.js`	`app/api/route.js`	Valid
`app/[user]/page.js`	`app/api/route.js`	Valid

各 route.js または page.js ファイルは、そのルートのすべての HTTP verbs を引き継ぎます。

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

// ❌ Conflict
// `app/route.js`
export async function POST(request) {}

Examples

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

静的データの再検証

静的データの再検証フェッチは、next.revalidateオプションを使って行うことができます：

app/items/route.ts
export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // Revalidate every 60 seconds
  })
  const data = await res.json()

  return Response.json(data)
}

あるいは、revalidate セグメント設定オプションを使うこともできます。

export const revalidate = 60

Dynamic Functions

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

Cookies

next/headersからcookiesを使ってクッキーを読み込むことができます。このサーバー関数は Route Handler の中で直接呼び出すことも、他の関数の中にネストして呼び出すこともできます。

この cookies インスタンスは読み取り専用です。クッキーを設定するには、Set-Cookie ヘッダを使用して新しい Response を返す必要があります。

app/api/route.ts
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}` },
  })
}

あるいは、クッキーを読むために、基礎となる 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')
}

Headers

next/headersからheadersを使ってヘッダーを読み込むことができます。このサーバー関数は Route Handler の中で直接呼び出すことも、他の関数の中にネストして呼び出すこともできます。

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

app/api/route.ts
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 },
  })
}

あるいは、ヘッダーを読み込むために、基礎となる 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)
}

Redirects

app/api/route.ts
import { redirect } from 'next/navigation'

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

動的ルート Segment

先に進む前に、Defining Routes ページを読むことをお勧めします。

ルートハンドラはDynamic Segmentsを使って、動的なデータからリクエストハンドラを作成できます。

app/items/[slug]/route.ts
export async function GET(
  request: Request,
  { params }: { params: { slug: string } }
) {
  const slug = params.slug // 'a', 'b', or 'c'
}

Route	Example 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 クエリパラメータ

Route Handler に渡されるリクエストオブジェクトは 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
}

Streaming

ストリーミングは、OpenAI のような大規模言語モデル（LLM）と組み合わせて、AI が生成するコンテンツによく使用されます。AI SDK の詳細はこちら。

app/api/chat/route.ts
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)
}

これらの抽象化は、ストリームを作成するために 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)
}

Request Body

標準の Web API メソッドを使ってリクエストボディを読むことができます。

app/items/route.ts
export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

Request Body FormData

FormData を読み込むには、request.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 メソッドを使用して、Response に CORS ヘッダを設定できます。

app/api/route.ts
export const dynamic = 'force-dynamic' // defaults to force-static

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

Edge and Node.js Runtimes

Route ハンドラは、ストリーミングのサポートを含め、Edge と Node.js の両方のランタイムをシームレスにサポートする同型の Web API を持っています。Route ハンドラは Pages や Layouts と同じroute segment configurationを使うので、汎用の静的に再生成されるRoute ハンドラのような待望の機能をサポートします。

ランタイムを指定するには、runtimeSegment コンフィグオプションを使います。

export const runtime = 'edge' // 'nodejs' is the default

Non-UI Responses

非 UI コンテンツを返すために Route ハンドラを使うことができます。sitemap.xml, robots.txt, app icons, と open graph images はすべてビルトインサポートです。

app/rss.xml/route.ts
export const dynamic = 'force-dynamic' // defaults to force-static

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

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

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

規約​

サポートされる HTTP メソッド​

拡張 NextRequest と NextResponse API​

Behavior​

キャッシング​

キャッシュのオプトアウト​

Route 解決​

Examples​

静的データの再検証​

Dynamic Functions​

Cookies​

Headers​

Redirects​

動的ルート Segment​

URL クエリパラメータ​

Streaming​

Request Body​

Request Body FormData​

CORS​

Edge and Node.js Runtimes​

Non-UI Responses​

Segment Config Options​

規約