Route Handlers

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

補足: Route Handlersはappディレクトリ内でのみ使用できます。これらはpagesディレクトリ内のAPI Routesに相当するものであり、API RoutesとRoute Handlersを一緒に使用する必要はありません。

規約

Route Handlersはappディレクトリ内のroute.js|tsファイルで定義されます：

app/api/route.ts

TypeScript

export async function GET(request: Request) {}

Route Handlersは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でこれらを拡張しています。

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

app/items/route.ts

TypeScript

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

補足: キャッシュされるGETメソッドと同じファイル内に配置されていても、その他のサポートされるHTTPメソッドはキャッシュされません。

特殊なRoute Handler

sitemap.ts、opengraph-image.tsx、icon.tsxなどの特殊なRoute Handlerや、その他のメタデータファイルは、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メソッドを処理します。

app/page.ts

TypeScript

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}
 
// ❌ コンフリクト
// `app/route.ts`
export async function POST(request: Request) {}

例

以下の例は、Route HandlersとNext.jsの他のAPIや機能を組み合わせる方法を示しています。

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

Incremental Static Regeneration（ISR）を使用してキャッシュされたデータを再検証できます：

app/posts/route.ts

TypeScript

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

Cookies

next/headersからcookiesを使用して、Cookieを読み取ったり設定したりできます。このサーバー関数は、Route Handler内で直接呼び出すことも、別の関数内にネストして呼び出すこともできます。

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

app/api/route.ts

TypeScript

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を読み取ることもできます：

app/api/route.ts

TypeScript

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

ヘッダー

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

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

app/api/route.ts

TypeScript

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

TypeScript

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

リダイレクト

app/api/route.ts

TypeScript

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

動的ルートセグメント

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

app/items/[slug]/route.ts

TypeScript

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

Route Handlerに渡されるリクエストオブジェクトはNextRequestインスタンスであり、クエリパラメータをより簡単に処理するための追加の便利なメソッドがいくつかあります。

app/api/search/route.ts

TypeScript

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の詳細をご覧ください。

app/api/chat/route.ts

TypeScript

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

TypeScript

// 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

TypeScript

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

リクエストボディFormData

request.formData()関数を使用してFormDataを読み取ることができます：

app/items/route.ts

TypeScript

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

CORS

標準のWeb APIメソッドを使用して、特定のRoute HandlerにCORSヘッダーを設定できます：

app/api/route.ts

TypeScript

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

補足:

複数のRoute HandlerにCORSヘッダーを追加するには、Middlewareまたはnext.config.jsファイルを使用できます。

または、CORSの例パッケージをご覧ください。

Webhooks

Route Handlerを使用して、サードパーティサービスからのWebhookを受信できます：

app/api/route.ts

TypeScript

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

特筆すべきは、Pages RouterのAPI Routesとは異なり、bodyParserを使用したり追加の設定をする必要がないことです。

UI以外のレスポンス

Route Handlersを使用して、UI以外のコンテンツを返すことができます。sitemap.xml、robots.txt、app icons、およびopen graphイメージはすべて組み込みのサポートがあることに注意してください。

app/rss.xml/route.ts

TypeScript

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

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

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

app/items/route.ts

TypeScript

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リファレンスをご覧ください。