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

route.js

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

route.ts
export async function GET() {
  return 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) {}

// `OPTIONS`が定義されていない場合、Next.jsは自動的に`OPTIONS`を実装し、Route Handlerで定義された他のメソッドに応じて適切なResponse `Allow`ヘッダーを設定します。
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: 現在のルートに対するdynamic route parametersを含むオブジェクトに解決されるプロミスです。
app/dashboard/[team]/route.ts
export async function GET(
  request: Request,
  { params }: { params: Promise<{ team: string }> }
) {
  const { team } = await params
}
例URLparams
app/dashboard/[team]/route.js/dashboard/1Promise<{ team: '1' }>
app/shop/[tag]/[item]/route.js/shop/1/2Promise<{ tag: '1', item: '2' }>
app/blog/[...slug]/route.js/blog/1/2Promise<{ slug: ['1', '2'] }>

例​

cookieの処理​

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-RCcontext.paramsがプロミスになりました。codemodが利用可能です
v15.0.0-RCGETハンドラのデフォルトキャッシュが静的から動的に変更されました
v13.2.0Route Handlersが導入されました。