Swagger 是一种流行的 API 规范，它可以帮助开发人员轻松地创建、维护和使用 RESTful API。在本文中，我们将介绍如何使用 Swagger 在 Express.js 中构建 API。
步骤1：安装 Swagger
首先，我们需要安装 swagger 和 swagger-ui-express 库。这可以通过以下命令完成：
npm install swagger swagger-ui-express --save
步骤2：定义 Swagger 规范
Swagger 规范描述了我们的 API 的细节，包括可用的路由、请求和响应的格式等。在 Express.js 中，我们可以使用 JSON 文件来定义 Swagger 规范。
以下是一个基本的 Swagger 规范示例：
-- -------------------- ---- -------
-
---------- ------
------- -
---------- --------
-------- ----------- ----
--
------- -----------------
----------- -------
---------- -
------
--
-------- -
--------- -
------ -
-------------- -------- --- -------
------------ -
------ -
-------------- -- ---- -- -------
--------- -
------- --------
-------- -
------- --------------------
-
-
-
-
-
-
--
-------------- -
------- -
------- ---------
------------- -
------- -
------- --------
--
------ -
------- --------
-
-
-
-
-在这个 Swagger 规范中，我们定义一个基本的 Express.js API，其中包括一个 GET 请求，返回一个包含用户信息的数组。我们还定义了一个名为 User 的对象，它具有 name 和 age 属性。
步骤3：创建 Express.js 应用程序
接下来，我们将创建一个简单的 Express.js 应用程序，并将 Swagger 规范添加到应用程序中。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --------- - ------------------------------ ----- --------------- - -------------------------- ----- --- - ---------- ----- ---- - ----- -------------------- ---------------- ---------------------------------- ---------------- -- -- -------------------- --- --------- -- ---- ------------
在这个应用程序中，我们将 Swagger 规范作为 swaggerDocument 导入，并使用 swagger-ui-express 库将其呈现为交互式文档。
步骤4：测试 API
现在，你可以运行你的应用程序并测试定义的 API。可以在浏览器中访问 http://localhost:3000/api-docs 来查看交互式文档。
总结
Swagger 是一个强大的工具，可以帮助我们轻松地创建和使用 RESTful API。在本文中，我们了解了如何使用 Swagger 在 Express.js 中构建 API。我们走过了定义 Swagger 规范、创建 Express.js 应用程序并将 Swagger 规范添加到应用程序中的步骤。现在，你可以开始使用 Swagger 来构建更好的、易于使用的 API了。
示例代码：前往 GitHub
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/646dccc0968c7c53b0c6d1da