39
章节39
创建 API 路由
API 路由 允许你在 Next.js 应用内部创建 API 端点。你可以通过在 pages/api
目录内创建一个 **函数** 来做到这一点,该函数具有以下格式
// req = HTTP incoming message, res = HTTP server response
export default function handler(req, res) {
// ...
}
在 API 路由 文档中了解更多关于上述请求处理程序的信息。
它们可以作为 Serverless Functions (也称为 Lambdas) 部署。
创建一个简单的 API 端点
让我们试一下。在 pages/api
中创建一个名为 hello.js
的文件,其中包含以下代码
export default function handler(req, res) {
res.status(200).json({ text: 'Hello' });
}
尝试在 https://:3000/api/hello 访问它。你应该看到 {"text":"Hello"}
。请注意
req
是 http.IncomingMessage 的一个实例,加上一些预构建的 middlewares。res
是 http.ServerResponse 的一个实例,加上一些 helper functions。
就是这样!在我们结束本课程之前,让我们在下一页讨论关于使用 API 路由 的一些技巧。
这有帮助吗?