跳到主要内容

API 路由

示例

提示：如果你正在使用 App 路由，可以使用服务端组件或 Route Handlers 来替代 API 路由。

API 路由为使用 Next.js 构建公共 API 提供了解决方案。

pages/api 文件夹内的任何文件都会映射到 /api/*，并被视为 API 端点而不是 page。它们仅在服务端打包，不会增加客户端的打包大小。

例如，以下 API 路由返回一个状态码为 200 的 JSON 响应：

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

type ResponseData = {
  message: string
}

export default function handler(
  req: NextApiRequest,
  res: NextApiResponse<ResponseData>
) {
  res.status(200).json({ message: 'Hello from Next.js!' })
}

提示：

参数​

export default function handler(req: NextApiRequest, res: NextApiResponse) {
  // ...
}

HTTP 方法​

要在 API 路由中处理不同的 HTTP 方法，你可以在请求处理程序中使用 req.method，如下所示：

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default function handler(req: NextApiRequest, res: NextApiResponse) {
  if (req.method === 'POST') {
    // 处理 POST 请求
  } else {
    // 处理任何其他 HTTP 方法
  }
}

请求辅助函数​

API 路由提供了内置的请求辅助函数，用于解析传入的请求（req）：

  • req.cookies - 包含请求发送的 cookies 的对象。默认为 {}
  • req.query - 包含查询字符串的对象。默认为 {}
  • req.body - 包含由 content-type 解析的请求体的对象，如果没有发送请求体则为 null

自定义配置​

每个 API 路由都可以导出一个 config 对象来更改默认配置，默认配置如下：

export const config = {
  api: {
    bodyParser: {
      sizeLimit: '1mb',
    },
  },
  // 指定此函数执行的最大允许持续时间（以秒为单位）
  maxDuration: 5,
}

bodyParser 会自动启用。如果你想将请求体作为 Stream 使用或使用 raw-body，可以将其设置为 false。

禁用自动 bodyParsing 的一个用例是允许你验证 webhook 请求的原始请求体，例如来自 GitHub 的请求。

export const config = {
  api: {
    bodyParser: false,
  },
}

bodyParser.sizeLimit 是解析后的请求体允许的最大大小，支持 bytes 支持的任何格式，如下所示：

export const config = {
  api: {
    bodyParser: {
      sizeLimit: '500kb',
    },
  },
}

externalResolver 是一个显式标志，告诉服务器此路由由外部解析器（如 express 或 connect）处理。启用此选项会禁用未解析请求的警告。

export const config = {
  api: {
    externalResolver: true,
  },
}

responseLimit 会自动启用，当 API 路由的响应体超过 4MB 时会发出警告。

如果你不在无服务器环境中使用 Next.js，并且了解不使用 CDN 或专用媒体主机的性能影响，可以将此限制设置为 false。

export const config = {
  api: {
    responseLimit: false,
  },
}

responseLimit 也可以接受字节数或 bytes 支持的任何字符串格式，例如 1000、'500kb' 或 '3mb'。 此值将是显示警告之前的最大响应大小。默认值为 4MB。（见上文）

export const config = {
  api: {
    responseLimit: '8mb',
  },
}

响应辅助函数​

服务器响应对象（通常缩写为 res）包含一组类似 Express.js 的辅助方法，可改善开发者体验并提高创建新 API 端点的速度。

包含的辅助函数有：

  • res.status(code) - 设置状态码的函数。code 必须是有效的 HTTP 状态码
  • res.json(body) - 发送 JSON 响应。body 必须是可序列化对象
  • res.send(body) - 发送 HTTP 响应。body 可以是 string、object 或 Buffer
  • res.redirect([status,] path) - 重定向到指定的路径或 URL。status 必须是有效的 HTTP 状态码。如果未指定，status 默认为 "307" "临时重定向"。
  • res.revalidate(urlPath) - 使用 getStaticProps 按需重新验证页面。urlPath 必须是 string。

设置响应的状态码​

向客户端发送响应时，你可以设置响应的状态码。

以下示例将响应的状态码设置为 200（OK），并将 message 属性的值设置为 Hello from Next.js! 作为 JSON 响应返回：

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

type ResponseData = {
  message: string
}

export default function handler(
  req: NextApiRequest,
  res: NextApiResponse<ResponseData>
) {
  res.status(200).json({ message: 'Hello from Next.js!' })
}

发送 JSON 响应​

向客户端发送响应时，你可以发送 JSON 响应，这必须是一个可序列化对象。 在实际应用中，你可能希望根据请求端点的结果让客户端知道请求的状态。

以下示例使用状态码 200（OK）发送 JSON 响应和异步操作的结果。它包含在 try catch 块中以处理可能发生的任何错误，捕获适当的状态码和错误消息并将其发送回客户端：

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  try {
    const result = await someAsyncOperation()
    res.status(200).json({ result })
  } catch (err) {
    res.status(500).json({ error: 'failed to load data' })
  }
}

发送 HTTP 响应​

发送 HTTP 响应的方式与发送 JSON 响应相同。唯一的区别是响应体可以是 string、object 或 Buffer。

以下示例使用状态码 200（OK）和异步操作的结果发送 HTTP 响应。

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  try {
    const result = await someAsyncOperation()
    res.status(200).send({ result })
  } catch (err) {
    res.status(500).send({ error: 'failed to fetch data' })
  }
}

重定向到指定路径或 URL​

以表单为例，你可能希望在客户端提交表单后将其重定向到指定的路径或 URL。

以下示例在表单成功提交后将客户端重定向到 / 路径：

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const { name, message } = req.body

  try {
    await handleFormInputAsync({ name, message })
    res.redirect(307, '/')
  } catch (err) {
    res.status(500).send({ error: 'Failed to fetch data' })
  }
}

添加 TypeScript 类型​

你可以通过从 next 导入 NextApiRequest 和 NextApiResponse 类型来使 API 路由更加类型安全，此外，你还可以为响应数据添加类型：

import type { NextApiRequest, NextApiResponse } from 'next'

type ResponseData = {
  message: string
}

export default function handler(
  req: NextApiRequest,
  res: NextApiResponse<ResponseData>
) {
  res.status(200).json({ message: 'Hello from Next.js!' })
}

提示：NextApiRequest 的 body 是 any 类型，因为客户端可能包含任何有效负载。在使用之前，你应该在运行时验证 body 的类型/形状。

动态 API 路由​

API 路由支持动态路由，并遵循用于 pages/ 的相同文件命名规则。

pages/api/post/[pid].ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const { pid } = req.query
  res.end(`Post: ${pid}`)
}

现在，对 /api/post/abc 的请求将响应文本：Post: abc。

捕获所有 API 路由​

通过在方括号内添加三个点（...），可以扩展 API 路由以捕获所有路径。例如：

  • pages/api/post/[...slug].js 匹配 /api/post/a，也匹配 /api/post/a/b、/api/post/a/b/c 等。

提示：你可以使用除 slug 以外的名称，例如：[...param]

匹配的参数将作为查询参数（示例中的 slug）发送到页面，并且它始终是一个数组，因此路径 /api/post/a 将具有以下 query 对象：

{ "slug": ["a"] }

而在 /api/post/a/b 的情况下，以及任何其他匹配路径，新参数将被添加到数组中，如下所示：

{ "slug": ["a", "b"] }

For example:

pages/api/post/[...slug].ts
import type { NextApiRequest, NextApiResponse } from 'next'

export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const { slug } = req.query
  res.end(`Post: ${slug.join(', ')}`)
}

现在，对 /api/post/a/b/c 的请求将响应文本：Post: a, b, c。

可选的捕获所有 API 路由​

通过将参数包含在双方括号中（[[...slug]]），可以使捕获所有路由变为可选。

例如，pages/api/post/[[...slug]].js 将匹配 /api/post、/api/post/a、/api/post/a/b 等。

捕获所有路由和可选的捕获所有路由之间的主要区别在于，对于可选路由，不带参数的路由也会被匹配（上面示例中的 /api/post）。

query 对象如下：

{ } // GET `/api/post`（空对象）
{ "slug": ["a"] } // `GET /api/post/a`（单元素数组）
{ "slug": ["a", "b"] } // `GET /api/post/a/b`（多元素数组）

注意事项​

  • 预定义的 API 路由优先于动态 API 路由，动态 API 路由优先于捕获所有 API 路由。请看以下示例：
    • pages/api/post/create.js - 将匹配 /api/post/create
    • pages/api/post/[pid].js - 将匹配 /api/post/1、/api/post/abc 等。但不匹配 /api/post/create
    • pages/api/post/[...slug].js - 将匹配 /api/post/1/2、/api/post/a/b/c 等。但不匹配 /api/post/create、/api/post/abc

流式响应​

虽然 Pages 路由确实支持使用 API 路由进行流式响应，但如果你使用的是 Next.js 14+，我们建议逐步采用 App 路由并使用 Route Handlers。

以下是如何使用 writeHead 从 API 路由流式传输响应：

pages/api/hello.js
import { NextApiRequest, NextApiResponse } from 'next'

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  res.writeHead(200, {
    'Content-Type': 'text/event-stream',
    'Cache-Control': "no-store",
  })
  let i = 0
  while (i < 10) {
    res.write(`data: ${i}\n\n`)
    i++
    await new Promise((resolve) => setTimeout(resolve, 1000))
  }
  res.end()
}
最后于 更新