Next.js - API 路由

API 路由是使用 Next.js 建立 Rest API 的一種方法。Next.js 對映到 /pages/api 資料夾中存在的任何檔案都將被視為 API 終結點。一個 API 函式示例 −

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

以下是需要考慮的一些重要要點。

• req − req 是 http.IncomingMessage 的一個例項，用於從請求中獲取資料。

• res − res 是 http.ServerResponse 的一個例項，用於將資料作為響應傳送出去。

讓我們建立一個例子來演示一下。

在這個例子中，我們要在 pages/api 目錄中建立一個 user.js。

讓我們更新 Global CSS Support 章節中使用的 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 D:\Node\nextjs
> next

ready - started server on https://:3000
info  - Loaded env from D:\Node\nextjs\.env.local
event - compiled successfully
event - build page: /api/user
wait  - compiling...
event - compiled successfully
event - build page: /next/dist/pages/_error
wait  - compiling...
event - compiled successfully

驗證輸出

在瀏覽器中開啟 localhost:3000/api/user ，你將看到以下輸出。

{"name":"Robert"}