route.js
Route Handlers（ルートハンドラ）を使用すると、WebのRequestおよびResponse APIを活用して、特定のルートに対するカスタムリクエストハンドラを作成できます。
HTTPメソッド
routeファイルを使用すると、特定のルートに対するカスタムリクエストハンドラを作成できます。以下のHTTPメソッドがサポートされています: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS。
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) {}export async function GET(request) {}
export async function HEAD(request) {}
export async function POST(request) {}
export async function PUT(request) {}
export async function DELETE(request) {}
export async function PATCH(request) {}
// `OPTIONS`が定義されていない場合、Next.jsは自動的に`OPTIONS`を実装し、ルートハンドラで定義された他のメソッドに応じて適切なResponseの`Allow`ヘッダーを設定します。
export async function OPTIONS(request) {}補足: Route Handlersは
appディレクトリ内でのみ利用可能です。API Routes（pages）とRoute Handlers（app）を一緒に使用する必要はありません。Route Handlersですべてのユースケースを処理できるはずです。
パラメータ
request (オプション)
requestオブジェクトはNextRequestオブジェクトで、WebのRequest APIを拡張したものです。NextRequestを使用すると、cookiesへの簡単なアクセスや拡張された解析済みURLオブジェクトnextUrlなど、受信リクエストをさらに制御できます。
context (オプション)
type Params = {
team: string
}
export async function GET(request: Request, context: { params: Params }) {
const team = context.params.team // '1'
}
// ルートパラメータに応じてparamsの型を定義します（以下の表を参照）
export async function GET(request, context: { params }) {
const team = context.params.team // '1'
}現在、contextの唯一の値はparamsで、これは現在のルートの動的ルートパラメータを含むオブジェクトです。
| 例 | URL | params |
|---|---|---|
app/dashboard/[team]/route.js | /dashboard/1 | { team: '1' } |
app/shop/[tag]/[item]/route.js | /shop/1/2 | { tag: '1', item: '2' } |
app/blog/[...slug]/route.js | /blog/1/2 | { slug: ['1', '2'] } |
NextResponse
Route HandlersはNextResponseオブジェクトを返すことでWeb Response APIを拡張できます。これにより、クッキーやヘッダーの設定、リダイレクト、リライトを簡単に行えます。APIリファレンスを参照。
バージョン履歴
| バージョン | 変更内容 |
|---|---|
v13.2.0 | Route Handlersが導入されました。 |