创建 API 路由

API 路由 (API Routes) 允许你在 Next.js 应用中创建 API 端点。你只需在 pages/api 目录下创建一个符合以下格式的 函数 即可:

// req = HTTP 传入消息, res = HTTP 服务器响应
export default function handler(req, res) {
  // ...
}

更多关于上述请求处理器的信息,请参阅 API 路由文档

这些路由可以作为无服务器函数 (Serverless Functions,也称为 Lambda) 部署。

创建简单的 API 端点

让我们来试试看。在 pages/api 目录下创建一个名为 hello.js 的文件,并添加以下代码:

export default function handler(req, res) {
  res.status(200).json({ text: 'Hello' });
}

尝试访问 http://localhost:3000/api/hello,你将看到 {"text":"Hello"}。请注意:

就是这样!在结束本节之前,我们将在下一页讨论一些使用 API 路由 (API Routes) 的技巧。

On this page