Next.js Api 路由简介

API 路由(API Routes) 是一种使用 Next.js 创建 REST API 的方法。 Next.js 映射 /pages/api 文件夹中存在的任何文件,并将被视为 API 端点。 API函数示例

export default (req, res) => {
   ...
}

以下是需要考虑的一些要点。

  • req - req 是 http.IncomingMessage 的一个实例,用于从请求中获取数据。
  • res - res 是 http.ServerResponse 的一个实例,用于发送数据作为响应。

让我们创建一个示例来看一下API 路由。

在这个例子中,我们将在 pages/api 目录中创建一个 user.js。

让我们更新 全局 CSS 支持章节中使用的 nextjs 项目。

在 pages/api 目录中创建 user.js 文件,如下所示。

export default (req, res) => {
   res.statusCode = 200
   res.setHeader('Content-Type', 'application/json')
   res.end(JSON.stringify({ name: 'Robert' }))
}

启动 Next.js 服务器

运行以下命令启动服务器

$ npm run dev

> nextjs@1.0.0 dev /workspace/node/nextjs
> next dev

ready - started server on 0.0.0.0:3000, url: http://localhost:3000
event - compiled client and server successfully in 495 ms (124 modules)

在浏览器中打开 localhost:3000/api/user ,我们将看到以下输出。

Nextjs Api 路由简介

查看笔记

扫码一下
查看教程更方便