跳到内容
API 参考文件系统约定route.js

route.js

路由处理器允许您使用 Web 请求和 响应 API 为给定路由创建自定义请求处理器。

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

参考

HTTP 方法

路由文件允许您为给定路由创建自定义请求处理器。支持以下 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 对象是一个 NextRequest 对象，它是 Web Request API 的扩展。NextRequest 为传入的请求提供了进一步的控制，包括轻松访问 cookies 和一个扩展的、解析后的 URL 对象 nextUrl。

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

context (可选)

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'] }>

路由上下文助手

您可以使用 RouteContext 对路由处理器上下文进行类型标注，以从路由字面量获取强类型的 params。RouteContext 是一个全局可用的助手。

app/users/[id]/route.ts
import type { NextRequest } from 'next/server'
 
export async function GET(_req: NextRequest, ctx: RouteContext<'/users/[id]'>) {
  const { id } = await ctx.params
  return Response.json({ id })
}

须知

  • 类型在 next dev、next build 或 next typegen 期间生成。
  • 在类型生成之后，RouteContext 助手全局可用。无需导入。

示例

Cookies

您可以使用 next/headers 中的 cookies 读取或设置 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')
}

或者，您可以使用 Set-Cookie 标头返回新的 Response。

app/api/route.ts
import { cookies } from 'next/headers'
 
export async function GET(request: Request) {
  const cookieStore = await cookies()
  const token = cookieStore.get('token')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token.value}` },
  })
}

您还可以使用底层 Web API 从请求（NextRequest）中读取 cookie。

app/api/route.ts
import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

标头

您可以使用 next/headers 中的 headers 读取标头。

route.ts
import { headers } from 'next/headers'
import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const headersList = await headers()
  const referer = headersList.get('referer')
}

此 headers 实例是只读的。要设置标头，您需要返回一个带有新 headers 的新 Response。

app/api/route.ts
import { headers } from 'next/headers'
 
export async function GET(request: Request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

您还可以使用底层 Web API 从请求（NextRequest）中读取标头。

app/api/route.ts
import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

重新验证缓存数据

您可以使用 revalidate 路由段配置选项重新验证缓存数据。

app/posts/route.ts
export const revalidate = 60
 
export async function GET() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()
 
  return Response.json(posts)
}

重定向

app/api/route.ts
import { redirect } from 'next/navigation'
 
export async function GET(request: Request) {
  redirect('https://nextjs.net.cn/')
}

动态路由段

路由处理器可以使用动态段从动态数据创建请求处理器。

app/items/[slug]/route.ts
export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a', 'b', or 'c'
}
路由示例 URLparams
app/items/[slug]/route.js/items/aPromise<{ slug: 'a' }>
app/items/[slug]/route.js/items/bPromise<{ slug: 'b' }>
app/items/[slug]/route.js/items/cPromise<{ slug: 'c' }>

URL 查询参数

传递给路由处理器的请求对象是一个 NextRequest 实例，其中包含一些额外的便捷方法，例如用于更轻松地处理查询参数的方法。

app/api/search/route.ts
import { type NextRequest } from 'next/server'
 
export function GET(request: NextRequest) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query is "hello" for /api/search?query=hello
}

流式传输

流式传输通常与大型语言模型 (LLM)（如 OpenAI）结合使用，用于生成 AI 内容。了解有关 AI SDK 的更多信息。

app/api/chat/route.ts
import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'
 
export async function POST(req: Request) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })
 
  return new StreamingTextResponse(result.toAIStream())
}

这些抽象使用 Web API 来创建流。您也可以直接使用底层 Web API。

app/api/route.ts
// https://mdn.org.cn/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator: any) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()
 
      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}
 
function sleep(time: number) {
  return new Promise((resolve) => {
    setTimeout(resolve, time)
  })
}
 
const encoder = new TextEncoder()
 
async function* makeIterator() {
  yield encoder.encode('<p>One</p>')
  await sleep(200)
  yield encoder.encode('<p>Two</p>')
  await sleep(200)
  yield encoder.encode('<p>Three</p>')
}
 
export async function GET() {
  const iterator = makeIterator()
  const stream = iteratorToStream(iterator)
 
  return new Response(stream)
}

请求正文

您可以使用标准 Web API 方法读取 Request 正文

app/items/route.ts
export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

请求正文 FormData

您可以使用 request.formData() 函数读取 FormData

app/items/route.ts
export async function POST(request: Request) {
  const formData = await request.formData()
  const name = formData.get('name')
  const email = formData.get('email')
  return Response.json({ name, email })
}

由于 formData 数据都是字符串，您可能需要使用 zod-form-data 来验证请求并以您喜欢的格式（例如 number）检索数据。

CORS

您可以使用标准 Web API 方法为特定的路由处理器设置 CORS 标头

app/api/route.ts
export async function GET(request: Request) {
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: {
      'Access-Control-Allow-Origin': '*',
      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
      'Access-Control-Allow-Headers': 'Content-Type, Authorization',
    },
  })
}

须知:

Webhooks

您可以使用路由处理器接收来自第三方服务的 Webhooks

app/api/route.ts
export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Process the webhook payload
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

值得注意的是，与 Pages Router 中的 API 路由不同，您无需使用 bodyParser 进行任何额外的配置。

非 UI 响应

您可以使用路由处理器返回非 UI 内容。请注意，sitemap.xml、robots.txt、app icons 和 开放图谱图像都内置支持。

app/rss.xml/route.ts
export async function GET() {
  return new Response(
    `<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0">
 
<channel>
  <title>Next.js Documentation</title>
  <link>https://nextjs.net.cn/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

段配置选项

路由处理器使用与页面和布局相同的路由段配置。

app/items/route.ts
export const dynamic = 'auto'
export const dynamicParams = true
export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'

更多详细信息请参见 API 参考。

版本历史

版本更改
v15.0.0-RCcontext.params 现在是一个 Promise。提供了 codemod
v15.0.0-RCGET 处理器的默认缓存从静态更改为动态。
v13.2.0引入路由处理器。