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

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のように、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
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: サポートされているその他のHTTPメソッドは、同じファイル内でキャッシュされたGETメソッドが置かれていても、キャッシュされません。

特別なRoute Handlers​

sitemap.ts、opengraph-image.tsx、およびicon.tsxやその他のメタデータファイルなどの特別なRoute Handlersは、デフォルトでは静的です。Dynamic APIsやダイナミックな設定オプションを使用しない限り、そうなります。

ルートの解決​

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.ts
export default function Page() {
  return <h1>Hello, Next.js!</h1>
}

// ❌ コンフリクト
// `app/route.ts`
export async function POST(request: 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インスタンスは読み取り専用です。ヘッダーを設定するには、新しいResponseを新しいheadersで返す必要があります。

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 Segments​

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

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')
  // query is "hello" for /api/search?query=hello
}

ストリーミング​

ストリーミングは、OpenAIなどの大規模言語モデル（LLMs）と組み合わせて、AI生成コンテンツ用に使用されることが一般的です。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オプション​

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

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