前言
sails-hook-spore 是一个基于 Sails.js 框架的中间件，其功能是提供一个基于 Swagger UI 的 API 后端文档生成器。该中间件在 Sails.js 项目中使用非常方便，只需要简单的几个命令就可以完成 API 文档的生成。
安装
安装 sails-hook-spore 很简单，只需要使用 npm 将其安装到你的项目中即可：
$ npm install sails-hook-spore --save
配置
在 Sails.js 项目中，需要将 sails-hook-spore 中间件添加到项目的配置中。这可以通过修改 config/http.js 文件来实现，如下所示：
-- -------------------- ---- -------
------------------- - -
----------- -
-- - ----- ----------
------ -
---------------
----------
-------------
-----------
---------
-------- -- -- ----- ---
---------
------
---------
-
--
-- -- ----- ---
------ -
------------ ------------ -- --------
-------- -
-- ------- ----
----- -
------ --- -----
-------- -------
--
-- ------- -- --- --
----- ------------------------------------
-
-
--在上述配置文件中，我们将 sails-hook-spore 中间件添加到了 middleware 列表中，并在 spore 属性中进行了一些配置。其中，routePrefix 属性指定了文档访问路径前缀，swagger 属性指定了文档的基本信息和 API 地址。
使用
在配置完成之后，我们需要运行 sails lift 命令来启动 Sails.js 应用程序。启动完成后，在浏览器中输入 http://localhost:1337/api-docs 就可以看到生成的文档了。
要注意的是，./api/controllers/*Controller.js 的 API 地址是根据 Sails.js 项目的目录结构而来的。如果你的项目存在嵌套目录，需要相应的修改该路径。
总结
sails-hook-spore 中间件是一个非常有用的工具，可以帮助开发者在 Sails.js 项目中快速、方便地生成 API 文档。在实际项目中，我们通常需要使用一些类似的工具来增加工作效率，希望本文对大家有所帮助。
示例代码
-- -------------------- ---- -------
---
- -----------------
-
- ------------ -- -----
--
-------------- - -
---
- --------
- -------
- ----
- ------------ ------
- ---------
- - ----------------
- ----------
- ----
- ------------ ----
--
----- -------- ----- ---- -
------------------------- ----- -------
-- ----- -
------ -------------------
-
------ ----------------
---
--
---
- --------
- ------------
- ----
- ------------ ---- -- ----
- ---------
- - ----------------
- -----------
- - ----- --
- ------------ -- --
- --- ----
- --------- ----
- ----- ------
- ----------
- ----
- ------------ -- -- ----
--
-------- -------- ----- ---- -
------------------------------------------- ----- ------
-- ----- -
------ -------------------
-
-- ------- -
------ ------------------- --- ---- ----- ---------
-
------ ---------------
---
--
---
- --------
- -------
- -----
- ------------ -----
- ---------
- - ----------------
- -----------
- - ----- ----
- ------------ ---
- --- --------
- --------- ----
- ----- ------
- - ----- -----
- ------------ --
- --- --------
- --------- ----
- ----- ------
- ----------
- ----
- ------------ -----
--
------- -------- ----- ---- -
--- ------ - -----------------
--------------------------------- ------------- ---------
-- ----- -
------ -------------------
-
------ ------------------
---
--
---
- --------
- ------------
- ----
- ------------ ---- -- ----
- ---------
- - ----------------
- -----------
- - ----- --
- ------------ -- --
- --- ----
- --------- ----
- ----- ------
- - ----- ----
- ------------ ---
- --- --------
- --------- ----
- ----- ------
- - ----- -----
- ------------ --
- --- --------
- --------- ----
- ----- ------
- ----------
- ----
- ------------ -------
--
------- -------- ----- ---- -
--- ------ - -----------------
---------------- ----------------- --------------------- --------------- ---------
-- ----- -
------ -------------------
-
-- ------------- -
------ ------------------- --- ---- ----- ---------
-
------ ---------------------
---
--
---
- --------
- ------------
- -------
- ------------ ---- -- --
- ---------
- - ----------------
- -----------
- - ----- --
- ------------ -- --
- --- ----
- --------- ----
- ----- ------
- ----------
- ----
- ------------ ------
--
-------- -------- ----- ---- -
----------------- ------------------------------- ------
-- ----- -
------ -------------------
-
------ ---------
---
-
--来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005726681e8991b448e898b