如何使用 Node.js 和 Express 创建 RESTful API?

阅读时长 5 分钟读完

在今天的互联网应用程序中,RESTful API 已经成为了一种非常流行的架构模式。RESTful API 可以被用来支持不同的客户端设备和应用程序,例如 iOS、Android、Web、桌面应用程序等等。因此,它已经成为了开发人员的首选架构模式之一。在本文中,我们将探讨如何使用 Node.js 和 Express 创建 RESTful API。

什么是 RESTful API?

RESTful API 是一种设计风格,用于创建支持客户端和服务端之间数据交互的应用程序。它是一种面向资源的 API,它利用 HTTP 请求方法来描述操作。在 RESTful API 中,每个 HTTP 请求都是独立的,这表示任何客户端或服务端都不需要持久连接。这使得 RESTful API 非常容易在不同设备和应用程序之间共享和使用。

通常,RESTful API 设计遵循以下约定:

  1. 使用 HTTP 请求方法来表示执行操作的意图,例如 GET、POST、PUT、DELETE 等。
  2. 使用 URI 标识资源,在 URL 的末尾使用名词,例如 /users、/posts、/comments 等。
  3. 使用 HTTP 状态码来表示响应状态。
  4. 使用 JSON 格式来传输数据。

现在让我们看一下使用 Node.js 和 Express 创建 RESTful API 的步骤:

步骤一:安装 Node.js 和 Express

在使用 Node.js 和 Express 创建 RESTful API 之前,您需要先安装 Node.js 和 Express。您可以在官方网站上下载 Node.js,并使用以下命令安装 Express:

步骤二:创建服务器

现在让我们创建一个简单的服务器,然后将其转换为 RESTful API。在文件夹中创建一个名为 server.js 的文件,并复制以下代码:

该应用程序将在端口 3000 上启动一个 Express 服务器。在命令行中执行以下命令启动服务器:

步骤三:创建路由

现在我们将在服务器上创建路由。路由用于处理特定 URI 的请求。在这个例子中,我们将创建一个名为 users 的路由,并在其中添加 GET、POST、PUT 和 DELETE 请求。在 server.js 文件下方添加以下代码:

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

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

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

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

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

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

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

我们首先在用户数组中创建三个用户。然后我们添加了 bodyParser,它允许我们解析来自 POST 和 PUT 请求的 JSON 数据。接下来,我们创建了四个路由,每个路由都处理不同的 HTTP 请求。GET 路由检索所有用户,POST 路由添加一个新用户,PUT 路由更新用户,并使用请求参数中指定的 ID 查找用户。DELETE 路由删除用户。

步骤四:测试 API

现在你可以通过在 Web 浏览器中输入 http://localhost:3000/users 来测试 RESTful API。它将返回包含所有用户的 JSON 数据。您可以使用 POST、PUT 和 DELETE 请求添加、更新或删除用户。

结论

在本文中,我们介绍了如何使用 Node.js 和 Express 创建 RESTful API。我们了解了 RESTful API 的基本概念,然后构建和测试了一个简单的 API。现在您可以使用这些技术来创建您自己的 RESTful API,以便在不同的设备和应用程序之间共享数据。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/67110004ad1e889fe2fd2a90

纠错
反馈