使用 Express.js 框架构建 RESTful API 的详细教程

什么是 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：

--- ------- ------- ------

创建 Express.js 应用程序

在项目根目录下创建一个名为 app.js 的文件，输入以下内容：

----- ------- - -------------------
----- --- - ----------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

创建路由

在 Express.js 中，路由是指应用程序如何响应客户端对特定端点的请求。可以使用 Express.js 的 Router 类创建路由。

在 app.js 文件中添加以下代码：

----- ------- - -------------------
----- --- - ----------

----- ------ - -----------------

--------------- ----- ---- -- -
  --------------- ---------
---

------------ --------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

在浏览器中输入 http://localhost:3000/，应该可以看到 "Hello World!"。

添加 RESTful API

在 app.js 文件中，添加以下代码：

----- ------- - -------------------
----- --- - ----------

----- ------ - -----------------

--------------- ----- ---- -- -
  --------------- ---------
---

------------------------ ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----------------
---

---------------------------- ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  ---------------
---

------------------------
------------ --------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

在浏览器中输入 http://localhost:3000/api/users，应该可以看到以下 JSON 数据：

-
  - ----- -- ------- ----- --
  - ----- -- ------- ------- --
  - ----- -- ------- ------- -
-

在浏览器中输入 http://localhost:3000/api/users/1，应该可以看到以下 JSON 数据：

- ----- -- ------- ----- -

添加 POST 请求

在 app.js 文件中，添加以下代码：

----- ------- - -------------------
----- --- - ----------

----- ------ - -----------------

--------------- ----- ---- -- -
  --------------- ---------
---

------------------------ ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----------------
---

---------------------------- ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  ---------------
---

------------------------- ----- ---- -- -
  ----- ---- - -
    --- ------------ - --
    ----- -------------
  --
  -----------------
  ---------------
---

------------------------
------------ --------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

使用 Postman 发送 POST 请求：

应该可以看到以下 JSON 数据：

- ----- -- ------- ------ -

添加 PUT 请求

在 app.js 文件中，添加以下代码：

----- ------- - -------------------
----- --- - ----------

----- ------ - -----------------

--------------- ----- ---- -- -
  --------------- ---------
---

------------------------ ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----------------
---

---------------------------- ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  ---------------
---

------------------------- ----- ---- -- -
  ----- ---- - -
    --- ------------ - --
    ----- -------------
  --
  -----------------
  ---------------
---

---------------------------- ----- ---- -- -
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  --------- - --------------
  ---------------
---

------------------------
------------ --------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

使用 Postman 发送 PUT 请求：

应该可以看到以下 JSON 数据：

- ----- -- ------- ----- --- -------- -

添加 DELETE 请求

在 app.js 文件中，添加以下代码：

----- ------- - -------------------
----- --- - ----------

----- ------ - -----------------

--------------- ----- ---- -- -
  --------------- ---------
---

------------------------ ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----------------
---

---------------------------- ----- ---- -- -
  ----- ----- - -
    - --- -- ----- ----- --
    - --- -- ----- ------- --
    - --- -- ----- ------- -
  --
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  ---------------
---

------------------------- ----- ---- -- -
  ----- ---- - -
    --- ------------ - --
    ----- -------------
  --
  -----------------
  ---------------
---

---------------------------- ----- ---- -- -
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  --------- - --------------
  ---------------
---

------------------------------- ----- ---- -- -
  ----- ---- - ------------ -- ---- --- -------------------------
  -- ------- ------ ------------------------- ---- ---- --- ----- -- --- --- ---------
  ----- ----- - --------------------
  ------------------- ---
  ---------------
---

------------------------
------------ --------

---------------- -- -- -
  ------------------- ------- -- ---- -------
---

使用 Postman 发送 DELETE 请求：

应该可以看到以下 JSON 数据：

- ----- -- ------- ----- --- -------- -

总结

通过本文，你学习了使用 Express.js 框架构建 RESTful API 的详细教程，包括：

  • 安装 Express.js
  • 创建 Express.js 应用程序
  • 创建路由
  • 添加 RESTful API
  • 添加 POST 请求
  • 添加 PUT 请求
  • 添加 DELETE 请求

希望这篇文章能为你构建 RESTful API 提供帮助和指导。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/65773ccdd2f5e1655d0c7553

阅读全文

猜你喜欢

  • Jest 在使用 ES6 模块时遇到的问题及解决方案

    在前端开发中，Jest 是一个广泛使用的测试框架。然而，当我们在使用 Jest 进行测试时，有时会遇到一些问题，特别是在使用 ES6 模块时。这篇文章将介绍一些常见的问题，并提供解决方案和示例代码。

    10 个月前
  • Koa2 实现基于微信公众号服务的网站集成

    微信公众号已成为现代社会中最为流行的社交媒体之一，它为企业和个人提供了一个非常好的平台来宣传和推广产品和服务。在这样的背景下，为了更好地将自己的网站与微信公众号服务集成起来，利用微信公众号的各种功能，...

    10 个月前
  • LESS 中如何实现切角（Cutout）效果？

    在前端开发中，切角效果是一种常用的设计元素，它可以让页面看起来更加美观和有层次感。而 LESS 是一种预处理器语言，它可以让我们更加方便地编写 CSS 样式。在 LESS 中实现切角效果也非常简单，本...

    10 个月前
  • 解决 ES7 async 函数不总是能在所有情况下工作的问题

    ES7 async 函数是一种异步编程的方式，它让 JavaScript 开发者可以更加方便地处理异步操作。但是，在某些情况下，ES7 async 函数并不能像我们期望的那样工作，这可能会导致一些奇怪...

    10 个月前
  • SSE 如何实现多用户同时连接？

    简介 SSE（Server-Sent Events）是一种基于 HTTP 的服务器推送技术，用于实现服务器向客户端推送事件，相比于 WebSocket 更加轻量级，且可以使用 HTTP 的各种特性，比...

    10 个月前
  • 如何解决 Socket.io 长轮询卡死问题？

    在前端开发中，Socket.io 是一个非常常见的实时通信库，它支持多种实时通信协议，包括 WebSocket、HTTP 长轮询等。然而，在使用 Socket.io 进行长轮询时，我们有时会遇到卡死的...

    10 个月前
  • Sequelize 如何使用 Model 配置

    Sequelize 是一个 Node.js 的 ORM(Object-Relational Mapping) 库，可以方便地操作数据库。在 Sequelize 中，Model 是一个非常重要的概念，它...

    10 个月前
  • 在 Express.js 中使用 Passport.js 进行 Google 身份验证的完全指南

    在现代 Web 应用程序中，身份验证是一个不可或缺的组件。而 Google 身份验证是一个流行的身份验证方式，因为大多数人都有 Google 帐户，并且可以使用它来登录到应用程序。

    10 个月前
  • 如何在 Vue.js 项目中使用 TypeScript 进行状态管理？

    在前端开发中，Vue.js 和 TypeScript 都是非常流行的技术。Vue.js 是一个渐进式 JavaScript 框架，可以帮助开发者构建高效的用户界面。

    10 个月前
  • RxJS 中的 catchError 操作符详解及使用案例

    在前端开发中，我们经常会遇到需要处理异步操作的情况。RxJS 是一个强大的库，它提供了一种响应式编程的方式来处理异步操作。在 RxJS 中，catchError 操作符是一个非常有用的工具，它可以让我...

    10 个月前
  • 怎么处理 ES10 中的 BigInt 数据类型

    ES10 中新增了一种数据类型 BigInt，它可以表示任意精度的整数，解决了 JavaScript 在处理大整数时的精度问题。本文将详细介绍 BigInt 的使用方法，并提供一些示例代码。

    10 个月前
  • Babel 如何正确处理 import 和 export

    在现代前端开发中，使用模块化已经成为了标配。而 ES6 的模块化语法中，import 和 export 扮演了重要角色。但是，由于浏览器的兼容性问题，我们需要使用 Babel 来将 ES6 的代码转换...

    10 个月前
  • CSS Flexbox 中的 flex-basis 属性详解

    在 CSS Flexbox 布局中，flex-basis 属性用于设置项目的初始主轴尺寸。本文将详细介绍 flex-basis 属性的用法、特性和示例代码，以帮助大家更好地理解和应用该属性。

    10 个月前
  • Angular 的渐进式 Web 应用程序（PWA）开发

    随着移动设备的普及，Web 应用程序的需求也在不断增加。为了更好地满足用户的需求，渐进式 Web 应用程序（PWA）应运而生。Angular 作为一款流行的前端框架，也提供了完整的支持 PWA 开发的...

    10 个月前
  • Android Material Design：使用 App Bar 实现折叠式标题

    如果你正在开发 Android 应用程序，那么你一定听说过 Material Design。Material Design 是 Google 推出的一种现代化的设计语言，它强调平面化、简洁化、直观化和...

    10 个月前
  • 如何在 Mongoose 中使用 Promise 进行异步控制？

    Mongoose 是一个 Node.js 的 MongoDB ORM 框架，它提供了方便的 API 用于与 MongoDB 进行交互。在使用 Mongoose 进行开发时，我们经常会遇到异步控制的问题...

    10 个月前
  • 在 Next.js 中使用 Firebase 进行云函数

    什么是 Next.js 和 Firebase？ Next.js 是一个基于 React 的轻量级框架，用于构建服务器渲染的应用程序。它提供了一些有用的功能，如自动代码分割、静态导出、预取和预加载等。

    10 个月前
  • 使用 Docker Compose 构建 Laravel 开发环境

    Laravel 是一个流行的 PHP Web 开发框架，它提供了许多便利的功能和工具，使得开发者可以更快速、更高效地开发 Web 应用程序。但是，配置 Laravel 开发环境可能会比较繁琐，因为需要...

    10 个月前
  • ESLint 和 TypeScript 结合的最佳实践

    ESLint 是一个流行的 JavaScript 代码检查工具，而 TypeScript 是一个静态类型的 JavaScript 超集。在前端开发中，ESLint 和 TypeScript 的结合可以...

    10 个月前
  • ECMAScript 2020 中的可选链操作符使用小技巧

    ECMAScript 2020 中引入了可选链操作符（Optional Chaining Operator），这是一个非常实用的新特性，能够让我们更加方便地处理 JavaScript 对象及其属性。

    10 个月前

相关推荐

    暂无文章