route.js

路由处理器 (Route Handlers) 允许您使用 Web Request 和 Response API 为指定路由创建自定义请求处理器。

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

参考文档

HTTP 方法

路由文件允许您为指定路由创建自定义请求处理器。支持以下 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) {}

参数

`request`（可选）

request 对象是一个 NextRequest 对象，它扩展了 Web Request API。NextRequest 让您可以进一步控制传入请求，包括轻松访问 cookies 和扩展的解析 URL 对象 nextUrl。

import type { NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const url = request.nextUrl
}

`context`（可选）

params：一个解析为包含当前路由动态路由参数对象的 Promise。

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

示例	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'] }>`

示例

处理 Cookies

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` 现在是一个 Promise。提供了代码迁移工具
`v15.0.0-RC`	`GET` 处理器的默认缓存行为从静态更改为动态
`v13.2.0`	引入路由处理器 (Route Handlers)

On this page