route.js

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

route.ts

TypeScript

export async function GET() {
  return Response.json({ message: 'Hello World' })
}

リファレンス

HTTPメソッド

route ファイルを使用すると、特定のルートのカスタムリクエストハンドラを作成できます。以下の HTTPメソッドがサポートされています：GET、POST、PUT、PATCH、DELETE、HEAD、および OPTIONS。

route.ts

TypeScript

export async function GET(request: Request) {}
 
export async function HEAD(request: Request) {}
 
export async function POST(request: Request) {}
 
export async function PUT(request: Request) {}
 
export async function DELETE(request: Request) {}
 
export async function PATCH(request: Request) {}
 
// `OPTIONS` が定義されていない場合、Next.jsは自動的に `OPTIONS` を実装し、ルートハンドラで定義された他のメソッドに応じて適切な Response `Allow` ヘッダーを設定します。
export async function OPTIONS(request: Request) {}

パラメータ

`request`（オプション）

request オブジェクトは、Web Request APIの拡張である NextRequest オブジェクトです。NextRequest は、受信リクエストをより詳細に制御でき、cookies への簡単なアクセスや、拡張された解析済みのURLオブジェクト nextUrl を提供します。

route.ts

TypeScript

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

`context`（オプション）

params：現在のルートの動的ルートパラメータを含むオブジェクトに解決されるプロミス。

app/dashboard/[team]/route.ts

TypeScript

export async function GET(
  request: Request,
  { params }: { params: Promise<{ team: string }> }
) {
  const team = (await params).team
}

例	URL	`params`
`app/dashboard/[team]/route.js`	`/dashboard/1`	`Promise<{ team: '1' }>`
`app/shop/[tag]/[item]/route.js`	`/shop/1/2`	`Promise<{ tag: '1', item: '2' }>`
`app/blog/[...slug]/route.js`	`/blog/1/2`	`Promise<{ slug: ['1', '2'] }>`

例

クッキーの処理

route.ts

TypeScript

import { cookies } from 'next/headers'
 
export async function GET(request: NextRequest) {
  const cookieStore = await cookies()
 
  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

バージョン履歴

バージョン	変更点
`v15.0.0-RC`	`context.params` が現在はプロミスです。コードモッドが利用可能です
`v15.0.0-RC`	`GET` ハンドラのデフォルトのキャッシングが静的から動的に変更されました
`v13.2.0`	ルートハンドラが導入されました。