メインコンテンツまでスキップ

Route Handlers

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

Route.js Special FileRoute.js Special File

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

規約​

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

app/api/route.ts
export async function GET(request: Request) {}

Route Handlersは、page.jsやlayout.jsと同様に任意の場所にネストできます。ただし、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
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 })
}

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

特殊なRoute Handlers​

sitemap.ts、opengraph-image.tsx、icon.tsxなどの特殊なRoute Handlersやその他のメタデータファイルは、Dynamic APIや動的設定オプションを使用しない限り、デフォルトで静的です。

ルート解決​

routeは最も低レベルのルーティングプリミティブと見なすことができます。

  • pageのようにレイアウトやクライアントサイドナビゲーションには参加しません。
  • page.jsと同じルートにroute.jsファイルが存在することはできません。
ページルート結果
app/page.jsapp/route.js コンフリクト
app/page.jsapp/api/route.js 有効
app/[user]/page.jsapp/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) {}

例​

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

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

インクリメンタル・スタティック・リジェネレーション（ISR）を利用してキャッシュされたデータを再検証できます：

app/posts/route.ts
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
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を使用して、リクエストから cookie を読み取ることもできます（NextRequest）：

app/api/route.ts
import { type NextRequest } from 'next/server'

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

ヘッダー​

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 = 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
import { type NextRequest } from 'next/server'

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

リダイレクト​

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

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

Dynamic Route Seguments​

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

Route Handlersは、ダイナミックデータからリクエストハンドラーを作成するためにDynamic Segmentsを使用できます。

app/items/[slug]/route.ts
export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const slug = (await params).slug // 'a', 'b', or 'c'
}
ルートサンプルURLparams
app/items/[slug]/route.js/items/aPromise<{ slug: 'a' }>
app/items/[slug]/route.js/items/bPromise<{ slug: 'b' }>
app/items/[slug]/route.js/items/cPromise<{ 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')
  // /api/search?query=helloの場合、queryは"hello"
}

ストリーミング​

ストリーミングは、AI生成コンテンツのためにOpenAIなどの巨大言語モデル（LLM）と組み合わせてよく使用されます。AI SDKについて詳しく学んでください。

app/api/chat/route.ts
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
// 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
export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

リクエストボディFormData​

request.formData()関数を使用して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メソッドを使用して、特定のRoute Handlerに対してCORSヘッダーを設定することができます：

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

Good to know:

Webhooks​

Route Handlerを使用してサードパーティサービスからのwebhookを受け取ることができます：

app/api/route.ts
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 imagesには、すべて組み込みのサポートがあります。

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

Segment Config Options​

Route Handlersは、ページやレイアウトと同じroute segment configを使用します。

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