nx-sails-swagger 是一款用于在 Sail.js 应用程序中生成 Swagger 规范的 npm 包。Swagger 规范是一种定义 RESTful API 的标准，可帮助我们更好地组织和管理我们的 API。
本文将为您演示如何使用 nx-sails-swagger 包来生成 Swagger 规范，并演示如何使用 Swagger 生成的规范来测试 API。
安装
在使用 nx-sails-swagger 包之前，您需要首先安装该包。可以使用以下命令在命令行界面中安装：
npm install nx-sails-swagger --save
使用
1.生成 Swagger 规范
nx-sails-swagger 包提供了一个名为 swagger.js 的文件，您可以在此文件中定义您的 API，并使用命令行工具自动生成 Swagger 规范。打开 swagger.js 文件插入如下代码：
-- -------------------- ---- -------
---------------------- - -
-------- -
------ ----
--
------ -
--------- -
---- -
----- ---------
------------ ---------
------------ -------
--------- -
------------------
--
---------- -
---- -
------------ -----
------- -
----- --------
------ -
----- --------------------
-
-
-
-
--
----- -
-------- --------
------------ ---------
----- -
------
--
----------- -
-
----- -------
--- -------
------- -
----- --------------------------
--
--------- ----
-
--
---------- -
---- -
------------ ----
-
-
-
-
--
------------ -
----- -
--------- --------- -----------
----------- -
--- -
----- ---------
------------ --- ---
--
----- -
----- ---------
------------ ------
-
-
--
----------- -
--------- ---------
----------- -
----- -
----- ---------
------------ ------
-
-
-
-
--通过上面代码，我们定义了一个包含两个 RESTful API 的 API，一个是“获取所有用户”的 GET 方法，另一个是“创建新用户”的 POST 方法。我们还定义了两个数据模型 User 和 CreateUser。
完成这个文件的定义后，使用以下命令行执行该命令：
node swagger.js
命令行将自动生成其中的 swagger.json 文件，这是我们的 Swagger 规范。
2.安装 Swagger UI
现在我们需要一个工具来解释这个 Swagger 规范，以帮助我们测试 API。 Swagger UI 可以让您更好地理解和测试Swagger 规范。
npm install swagger-ui --save
3.配置应用程序
为了将 Swagger UI 集成到我们的应用程序中，我们需要在 Sails.js 的 config/http.js 文件中进行如下修改：
-- -------------------- ---- -------
------------------- - -
----------- -
------ -
-- ---
------------ -- --- ----
--------- -- --- ----
------ -- --- ----
---------- -- --- ----
------ -- --- ----
----- -- --- ----
--
---------- ----------------------- -- --- ----
-- ---- -- --- --- ----
-------- ----------------
-- ---- -- ----------
---------- -------------------------------
-- -- --- ----
-
--4.启动应用程序
在您的 Sails.js 应用程序目录中，使用以下命令启动应用程序：
sails lift
5.测试您的 API
现在，您的应用程序应该在端口 1337 上运行，并在 http://localhost:1337/swagger 上具有 Swagger UI。
在 Swagger UI 中，您可以测试 API，检查参数和响应的代码，甚至可以在这里生成客户端代码。
结论
nx-sails-swagger 是一个方便的工具，可帮助我们为 Sails.js 应用程序创建 Swagger 规范，更好地组织和管理我们的 API。同时，它还可以使我们的 API 更加可测试和可读。希望本文能为您提供足够的帮助来使用 nx-sails-swagger 包。
示例代码
-- -------------------- ---- -------
---------------------- - -
-------- -
------ ----
--
------ -
--------- -
---- -
----- ---------
------------ ---------
------------ -------
--------- -
------------------
--
---------- -
---- -
------------ -----
------- -
----- --------
------ -
----- --------------------
-
-
-
-
--
----- -
-------- --------
------------ ---------
----- -
------
--
----------- -
-
----- -------
--- -------
------- -
----- --------------------------
--
--------- ----
-
--
---------- -
---- -
------------ ----
-
-
-
-
--
------------ -
----- -
--------- --------- -----------
----------- -
--- -
----- ---------
------------ --- ---
--
----- -
----- ---------
------------ ------
-
-
--
----------- -
--------- ---------
----------- -
----- -
----- ---------
------------ ------
-
-
-
-
--来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f963d1de16d83a66d03