API 路由

示例

须知：如果您正在使用 App Router，则可以使用服务器组件或路由处理程序，而不是 API 路由。

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

pages/api 文件夹内的任何文件都映射到 /api/*，并将被视为 API 端点而不是 页面。它们是仅限服务器端的 bundle，不会增加您的客户端 bundle 大小。

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

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

须知:

API 路由不指定 CORS 标头，这意味着它们默认是同源的。您可以通过使用CORS 请求助手包装请求处理程序来自定义此行为。

API 路由不能与静态导出一起使用。但是，App Router 中的路由处理程序可以。
- API 路由将受到 next.config.js 中pageExtensions 配置的影响。

参数

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

req：http.IncomingMessage 的实例
res：http.ServerResponse 的实例

HTTP 方法

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

import type { NextApiRequest, NextApiResponse } from 'next'
 
export default function handler(req: NextApiRequest, res: NextApiResponse) {
  if (req.method === 'POST') {
    // Process a POST request
  } else {
    // Handle any other HTTP method
  }
}

请求助手

API 路由提供内置的请求助手，可解析传入请求 (req)

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

自定义配置

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

export const config = {
  api: {
    bodyParser: {
      sizeLimit: '1mb',
    },
  },
  // Specifies the maximum allowed duration for this function to execute (in seconds)
  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 响应

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 响应，这必须是一个可序列化对象。在实际应用中，您可能希望根据请求端点的结果让客户端知道请求的状态。

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

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。

以下示例发送一个 HTTP 响应，状态码为 200 (OK)，并包含异步操作的结果。

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。

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

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 的主体是 any，因为客户端可能包含任何有效负载。您应该在使用它之前在运行时验证主体的类型/形状。

动态 API 路由

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

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

例如

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` (empty object)
{ "slug": ["a"] } // `GET /api/post/a` (single-element array)
{ "slug": ["a", "b"] } // `GET /api/post/a/b` (multi-element array)

注意事项

预定义 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 Router 确实支持 API 路由的流式响应，但如果您的 Next.js 版本是 14+，我们建议逐步采用 App Router 并使用路由处理程序。

以下是您如何使用 writeHead 从 API 路由流式传输响应的方法

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