介绍
RESTful API 是一种基于 REST（Representational State Transfer）架构风格的 API，它是一种轻量级的、可扩展的、易于理解和使用的 Web API 设计风格。RESTful API 通常使用 HTTP 协议来进行通信，它可以让不同的应用程序之间进行互操作，从而实现更好的数据交互和资源共享。
在本文中，我们将使用 NodeJS 和 ExpressJS 创建一个简单的 RESTful API，以展示如何使用这些工具来构建一个基本的 Web API。
前置条件
在开始之前，您需要安装 NodeJS 和 ExpressJS。您可以从官方网站下载并安装它们，或者使用您喜欢的包管理器进行安装。
创建项目
首先，我们需要创建一个新的 NodeJS 项目。打开终端并执行以下命令：
mkdir my-rest-api cd my-rest-api npm init -y
这将创建一个名为 my-rest-api 的新项目，并使用默认配置文件初始化它。
接下来，我们需要安装 ExpressJS。执行以下命令：
npm install express
这将安装 ExpressJS 并将其添加到 package.json 文件中的依赖项列表中。
编写代码
创建一个名为 index.js 的新文件，并将以下代码添加到文件中：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - --------- ------------ ----- ---- -- - --------------- -------- -- ---------------- -- -- - ------------------- ------- -- ---- ------ --
这是一个非常基本的 ExpressJS 应用程序，它将在根路径上返回一个简单的 “Hello World!” 消息。
现在，我们将添加一个简单的 RESTful API 端点。将以下代码添加到 index.js 文件中：
-- -------------------- ---- -------
----- ------- - ------------------
----- --- - ---------
----- ----- - -
- --- -- ----- ------- --
- --- -- ----- ----- --
- --- -- ----- --------- --
-
------------ ----- ---- -- -
--------------- --------
--
----------------- ----- ---- -- -
---------------
--
--------------------- ----- ---- -- -
----- ---- - ------------ -- ---- --- ------------------------
-- ------- -
-------------------------- --- -------
- ---- -
--------------
-
--
---------------- -- -- -
------------------- ------- -- ---- ------
--这个代码添加了两个新的路由。第一个路由是 /users，它将返回一个包含所有用户的 JSON 数组。第二个路由是 /users/:id，它将返回一个指定 ID 的用户的 JSON 对象。如果用户不存在，则返回一个 404 状态码。
测试 API
现在，我们已经创建了一个简单的 RESTful API，我们可以使用 Postman 或任何其他 HTTP 客户端来测试它。
首先，我们可以使用 GET 请求来获取所有用户。使用以下 URL：
http://localhost:3000/users
这将返回以下 JSON 响应：
-- -------------------- ---- -------
-
-
----- --
------- -------
--
-
----- --
------- -----
--
-
----- --
------- ---------
-
-接下来，我们可以使用 GET 请求来获取一个指定 ID 的用户。使用以下 URL：
http://localhost:3000/users/1
这将返回以下 JSON 响应：
{
"id": 1,
"name": "Alice"
}如果我们尝试获取一个不存在的用户，例如 ID 4，我们将收到一个 404 响应：
http://localhost:3000/users/4
响应：
User not found
结论
本文介绍了如何使用 NodeJS 和 ExpressJS 创建一个简单的 RESTful API。我们创建了一个基本的 ExpressJS 应用程序，并添加了两个路由来实现 RESTful API。我们还测试了 API，并展示了如何使用 HTTP 客户端来测试它。这是一个非常基本的示例，但它可以为您提供一个基本的理解和起点，以便您可以构建更复杂的 API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6725818b2e7021665e181ef0