route.js

路由处理程序允许您使用 Web Request 和 Response API 为给定路由创建自定义请求处理程序。

typescript

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

javascript

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

参考

HTTP 方法

路由文件允许您为给定路由创建自定义请求处理程序。支持以下 HTTP 方法：GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS。

typescript

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) {}

javascript

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) {}

// 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 对象是一个 NextRequest 对象，它是 Web Request API 的扩展。NextRequest 允许您对传入请求进行更进一步的控制，包括轻松访问 cookies 和一个扩展的、已解析的 URL 对象 nextUrl。

typescript

import type { NextRequest } from 'next/server'

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

javascript

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

`context`（可选）

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

typescript

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

javascript

export async function GET(request, { params }) {
  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'] }>`

路由上下文辅助函数

您可以使用 RouteContext 类型化路由处理程序上下文，以从路由字面量中获取强类型 params。RouteContext 是一个全局可用的辅助函数。

typescript

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。

typescript

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

javascript

import { cookies } from 'next/headers'

export async function GET(request) {
  const cookieStore = await cookies()

  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

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

typescript

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}` },
  })
}

javascript

import { cookies } from 'next/headers'

export async function GET(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 从请求中读取 cookie (NextRequest)：

typescript

import { type NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

javascript

export async function GET(request) {
  const token = request.cookies.get('token')
}

头部

您可以使用 next/headers 中的 headers 读取头部信息。

typescript

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

javascript

import { headers } from 'next/headers'

export async function GET(request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
}

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

typescript

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 },
  })
}

javascript

import { headers } from 'next/headers'

export async function GET(request) {
  const headersList = await headers()
  const referer = headersList.get('referer')

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

您还可以使用底层的 Web API 从请求中读取头部信息 (NextRequest)：

typescript

import { type NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

javascript

export async function GET(request) {
  const requestHeaders = new Headers(request.headers)
}

重新验证缓存数据

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

typescript

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)
}

javascript

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)
}

重定向

typescript

import { redirect } from 'next/navigation'

export async function GET(request: Request) {
  redirect('https://nextjs.org/')
}

javascript

import { redirect } from 'next/navigation'

export async function GET(request) {
  redirect('https://nextjs.org/')
}

动态路由段

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

typescript

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a', 'b', or 'c'
}

javascript

export async function GET(request, { params }) {
  const { slug } = await params // 'a', 'b', or 'c'
}

路由	示例 URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`Promise<{ slug: 'a' }>`
`app/items/[slug]/route.js`	`/items/b`	`Promise<{ slug: 'b' }>`
`app/items/[slug]/route.js`	`/items/c`	`Promise<{ slug: 'c' }>`

URL 查询参数

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

typescript

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
}

javascript

export function GET(request) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query is "hello" for /api/search?query=hello
}

流式传输

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

typescript

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())
}

javascript

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'

export async function POST(req) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })

  return new StreamingTextResponse(result.toAIStream())
}

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

typescript

// https://developer.mozilla.org/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)
}

javascript

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()

      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}

function sleep(time) {
  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 的请求体：

typescript

export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

javascript

export async function POST(request) {
  const res = await request.json()
  return Response.json({ res })
}

请求体 FormData

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

typescript

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 })
}

javascript

export async function POST(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 头部：

typescript

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',
    },
  })
}

javascript

export async function GET(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',
    },
  })
}

须知：

要为多个路由处理程序添加 CORS 头部，您可以使用 Proxy 或 next.config.js 文件。

Webhooks

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

typescript

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,
  })
}

javascript

export async function POST(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 和开放图谱图像都具有内置支持。

typescript

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

javascript

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`)
}

路由段配置选项

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

typescript

export const dynamic = 'auto'
export const dynamicParams = true
export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'

javascript

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-RC`	`context.params` 现在是一个 Promise。提供了 codemod
`v15.0.0-RC`	`GET` 处理程序的默认缓存从静态更改为动态
`v13.2.0`	引入了路由处理程序。

路由处理程序允许您使用 Web Request 和 Response API 为给定路由创建自定义请求处理程序。

typescript

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

javascript

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

参考

HTTP 方法

路由文件允许您为给定路由创建自定义请求处理程序。支持以下 HTTP 方法：GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS。

typescript

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) {}

javascript

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) {}

// 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`（可选）

typescript

import type { NextRequest } from 'next/server'

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

javascript

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

`context`（可选）

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

typescript

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

javascript

export async function GET(request, { params }) {
  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'] }>`

路由上下文辅助函数

您可以使用 RouteContext 类型化路由处理程序上下文，以从路由字面量中获取强类型 params。RouteContext 是一个全局可用的辅助函数。

typescript

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。

typescript

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

javascript

import { cookies } from 'next/headers'

export async function GET(request) {
  const cookieStore = await cookies()

  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

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

typescript

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}` },
  })
}

javascript

import { cookies } from 'next/headers'

export async function GET(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 从请求中读取 cookie (NextRequest)：

typescript

import { type NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

javascript

export async function GET(request) {
  const token = request.cookies.get('token')
}

头部

您可以使用 next/headers 中的 headers 读取头部信息。

typescript

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

javascript

import { headers } from 'next/headers'

export async function GET(request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
}

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

typescript

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 },
  })
}

javascript

import { headers } from 'next/headers'

export async function GET(request) {
  const headersList = await headers()
  const referer = headersList.get('referer')

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

您还可以使用底层的 Web API 从请求中读取头部信息 (NextRequest)：

typescript

import { type NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

javascript

export async function GET(request) {
  const requestHeaders = new Headers(request.headers)
}

重新验证缓存数据

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

typescript

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)
}

javascript

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)
}

重定向

typescript

import { redirect } from 'next/navigation'

export async function GET(request: Request) {
  redirect('https://nextjs.org/')
}

javascript

import { redirect } from 'next/navigation'

export async function GET(request) {
  redirect('https://nextjs.org/')
}

动态路由段

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

typescript

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a', 'b', or 'c'
}

javascript

export async function GET(request, { params }) {
  const { slug } = await params // 'a', 'b', or 'c'
}

路由	示例 URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`Promise<{ slug: 'a' }>`
`app/items/[slug]/route.js`	`/items/b`	`Promise<{ slug: 'b' }>`
`app/items/[slug]/route.js`	`/items/c`	`Promise<{ slug: 'c' }>`

URL 查询参数

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

typescript

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
}

javascript

export function GET(request) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query is "hello" for /api/search?query=hello
}

流式传输

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

typescript

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())
}

javascript

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'

export async function POST(req) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })

  return new StreamingTextResponse(result.toAIStream())
}

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

typescript

// https://developer.mozilla.org/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)
}

javascript

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()

      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}

function sleep(time) {
  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 的请求体：

typescript

export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

javascript

export async function POST(request) {
  const res = await request.json()
  return Response.json({ res })
}

请求体 FormData

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

typescript

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 })
}

javascript

export async function POST(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 头部：

typescript

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',
    },
  })
}

javascript

export async function GET(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',
    },
  })
}

须知：

要为多个路由处理程序添加 CORS 头部，您可以使用 Proxy 或 next.config.js 文件。

Webhooks

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

typescript

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,
  })
}

javascript

export async function POST(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 和开放图谱图像都具有内置支持。

typescript

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

javascript

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`)
}

路由段配置选项

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

typescript

export const dynamic = 'auto'
export const dynamicParams = true
export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'

javascript

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-RC`	`context.params` 现在是一个 Promise。提供了 codemod
`v15.0.0-RC`	`GET` 处理程序的默认缓存从静态更改为动态
`v13.2.0`	引入了路由处理程序。

文档导航

参考

HTTP 方法

参数

request（可选）

context（可选）

路由上下文辅助函数

示例

Cookies

头部

重新验证缓存数据

重定向

动态路由段

URL 查询参数

流式传输

请求体

请求体 FormData

CORS

Webhooks

非 UI 响应

路由段配置选项

版本历史

参考

HTTP 方法

参数

request（可选）

context（可选）

路由上下文辅助函数

示例

Cookies

头部

重新验证缓存数据

重定向

动态路由段

URL 查询参数

流式传输

请求体

请求体 FormData

CORS

Webhooks

非 UI 响应

路由段配置选项

版本历史

`request`（可选）

`context`（可选）

`request`（可选）

`context`（可选）