什么是 RESTful API?
RESTful API 是一种基于 HTTP 协议,以资源为中心、通过 URL 定位资源、使用 HTTP 方法进行操作、数据交互格式为 JSON 或 XML 等标准数据格式的 Web API。
为什么要使用 Express.js 框架构建 RESTful API?
Express.js 是 Node.js 的一个轻量级 Web 框架,它提供了简单、快速、灵活的 Web 应用程序开发方式。使用 Express.js 框架可以快速构建 RESTful API,提高开发效率和代码可维护性。
开始构建 RESTful API
安装 Express.js
使用 npm 命令安装 Express.js:
npm install express --save
创建 Express.js 应用程序
在项目根目录下创建一个名为 app.js 的文件,输入以下内容:
const express = require('express'); const app = express(); app.listen(3000, () => { console.log('Server started on port 3000'); });
创建路由
在 Express.js 中,路由是指应用程序如何响应客户端对特定端点的请求。可以使用 Express.js 的 Router 类创建路由。
在 app.js 文件中添加以下代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------- --------------- ----- ---- -- - --------------- --------- --- ------------ -------- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
在浏览器中输入 http://localhost:3000/,应该可以看到 "Hello World!"。
添加 RESTful API
在 app.js 文件中,添加以下代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------- --------------- ----- ---- -- - --------------- --------- --- ------------------------ ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ---------------- --- ---------------------------- ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------------- --- ------------------------ ------------ -------- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
在浏览器中输入 http://localhost:3000/api/users,应该可以看到以下 JSON 数据:
[ { "id": 1, "name": "Tom" }, { "id": 2, "name": "Jerry" }, { "id": 3, "name": "Spike" } ]
在浏览器中输入 http://localhost:3000/api/users/1,应该可以看到以下 JSON 数据:
{ "id": 1, "name": "Tom" }
添加 POST 请求
在 app.js 文件中,添加以下代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------- --------------- ----- ---- -- - --------------- --------- --- ------------------------ ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ---------------- --- ---------------------------- ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------------- --- ------------------------- ----- ---- -- - ----- ---- - - --- ------------ - -- ----- ------------- -- ----------------- --------------- --- ------------------------ ------------ -------- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
使用 Postman 发送 POST 请求:
- URL: http://localhost:3000/api/users
- Body: { "name": "Tyke" }
- Header: Content-Type: application/json
应该可以看到以下 JSON 数据:
{ "id": 4, "name": "Tyke" }
添加 PUT 请求
在 app.js 文件中,添加以下代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------- --------------- ----- ---- -- - --------------- --------- --- ------------------------ ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ---------------- --- ---------------------------- ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------------- --- ------------------------- ----- ---- -- - ----- ---- - - --- ------------ - -- ----- ------------- -- ----------------- --------------- --- ---------------------------- ----- ---- -- - ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------- - -------------- --------------- --- ------------------------ ------------ -------- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
使用 Postman 发送 PUT 请求:
- URL: http://localhost:3000/api/users/4
- Body: { "name": "Tyke the Bulldog" }
- Header: Content-Type: application/json
应该可以看到以下 JSON 数据:
{ "id": 4, "name": "Tyke the Bulldog" }
添加 DELETE 请求
在 app.js 文件中,添加以下代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------- --------------- ----- ---- -- - --------------- --------- --- ------------------------ ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ---------------- --- ---------------------------- ----- ---- -- - ----- ----- - - - --- -- ----- ----- -- - --- -- ----- ------- -- - --- -- ----- ------- - -- ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------------- --- ------------------------- ----- ---- -- - ----- ---- - - --- ------------ - -- ----- ------------- -- ----------------- --------------- --- ---------------------------- ----- ---- -- - ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- --------- - -------------- --------------- --- ------------------------------- ----- ---- -- - ----- ---- - ------------ -- ---- --- ------------------------- -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- --------- ----- ----- - -------------------- ------------------- --- --------------- --- ------------------------ ------------ -------- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
使用 Postman 发送 DELETE 请求:
应该可以看到以下 JSON 数据:
{ "id": 4, "name": "Tyke the Bulldog" }
总结
通过本文,你学习了使用 Express.js 框架构建 RESTful API 的详细教程,包括:
- 安装 Express.js
- 创建 Express.js 应用程序
- 创建路由
- 添加 RESTful API
- 添加 POST 请求
- 添加 PUT 请求
- 添加 DELETE 请求
希望这篇文章能为你构建 RESTful API 提供帮助和指导。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/65773ccdd2f5e1655d0c7553