什么是 Swagger
Swagger 是一种 API 文档化工具，它能够帮助开发者快速、简便的创建和维护 RESTful API 文档，并生成易于阅读和部署的文档。
Swagger 的核心规范是 OpenAPI 规范。OpenAPI 规范是一个 RESTful API 规范，其目的是帮助开发人员创建易于使用、功能丰富的 RESTful API。
Swagger 的主要特点：
- 自动生成 API 文档
- 支持多种语言
- 自动生成测试代码
- 支持在线调试 API
- 支持权限管理
如何使用 Swagger
步骤一：安装 Swagger
使用 npm 安装 Swagger：
npm install -g swagger
步骤二：创建 Swagger.json 文件
在项目根目录下创建 swagger.json 文件。该文件包含 API 的详细信息，例如 API 的名称、描述、请求方法、请求参数、响应、错误码等等。
示例 swagger.json 文件：
-- -------------------- ---- -------
-
---------- ------
------- -
-------- --- -----
-------------- ------- -----
---------- -------
--
------- -----------------
----------- -------
---------- ---------
-------- -
--------- -
------ -
---------- ---------
------- ----------
------------ -
------ -
-------------- -----
-
-
-
-
-
-步骤三：部署 Swagger
在 swagger.json 所在目录下启动 Swagger：
swagger project start
打开浏览器，访问 http://localhost:3030/docs，即可查看 API 文档。
步骤四：使用 Swagger
在 http://localhost:3030/docs 页面，您可以查看 API 的详细信息，包括请求和响应参数、响应状态码等等。您还可以使用 Swagger 生成测试代码，帮助您在项目中使用 API。
总结
Swagger 是一个非常强大的工具，可以帮助开发人员轻松创建和维护 RESTful API 文档，是开发一个 API 必不可少的工具。如果您还没有使用 Swagger，那么我建议您尝试使用它。
示例代码：
- API：
app.get('/users', function (req, res) {
var users = [{}, {}, {}]; // 假设这里有三个用户, 仅供参考
res.send(users);
});- Swagger.json：
-- -------------------- ---- -------
-
---------- ------
------- -
-------- --- -----
-------------- ------- -----
---------- -------
--
------- -----------------
----------- -------
---------- ---------
-------- -
--------- -
------ -
---------- ---------
------- ----------
------------ -
------ -
-------------- -----
--------- -
------- --------
-------- -
------- --------------------
-
-
-
-
-
-
--
-------------- -
------- -
------- ---------
----------- -
-------
-----
--
------------- -
------- -
------- ---------
---------- -------
--
------ -
------- ----------
---------- --
--
-------- -
------- ---------
---------- -------------------
-
-
-
-
-来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/652223c895b1f8cacd9882c4