route.js

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

route.ts

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

リファレンス

HTTP メソッド

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

route.ts

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) {}
 
// If `OPTIONS` is not defined, Next.js will automatically implement `OPTIONS` and set the appropriate Response `Allow` header depending on the other methods defined in the Route Handler.
export async function OPTIONS(request: Request) {}

パラメータ

`request` (オプション)

request オブジェクトは、Web の Request API の拡張である NextRequest オブジェクトです。NextRequest を使用すると、受信リクエストをさらに制御できます。これには、`cookies` への簡単なアクセスや、拡張され解析された URL オブジェクト `nextUrl` へのアクセスも含まれます。

route.ts

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

`context` (オプション)

params: 現在のルートの動的ルートパラメータを含むオブジェクトを解決するPromise。

app/dashboard/[team]/route.ts

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

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` は、プロミスになりました。 codemod をご利用いただけます。
`v15.0.0-RC`	`GET`ハンドラのデフォルトのキャッシュが、静的から動的になりました。
`v13.2.0`	ルートハンドラーが導入されました。

役に立ちましたか？