随着前端开发的不断发展，前后端的解耦越来越明显，前端程序员也需要在自己的项目中动态生成请求参数与响应数据，而 swagger2 包就是一个非常方便的 npm 包，能够方便地生成 API 文档，非常适用于前端开发人员。
安装
在安装 swagger2 包之前，需要先全局安装 swagger-ui 包：
npm install -g swagger-ui
然后再安装 swagger2 包：
npm install swagger2
使用
创建 swagger 配置文件，命名为 swagger.js：
-- -------------------- ---- -------
-------------- - -
------------------ -
----- -
------ ---- ----
-------- --------
------------ ------- --- ----
--
----- -----------------
--------- ----
--------- -
-------------------
--
-------- -------- ---------
--
----- ------------------
--然后在 app.js 中引入：
-- -------------------- ---- ------- ----- ------- - -------------------- ----- --------- - ------------------------------ ----- --------------- - ------------------------ ----- --- - ---------- -------------------- ---------------- ---------------------------------- -----------------------------
创建 API 文件 routes/example.js，示例代码如下：
-- -------------------- ---- ------- --- - -------- - --------- - ---- - ------------ -- ------- - ---------- - ---- - ------------ ---- - -------- - ----------------- - ------- - ----- ------ - ----------- - -------- - ----- ------ - ------------ ------- -- - -------- -------- -- ---------------------- ----- ---- -- - ---------- -------- -------- --- ---
最后在终端运行以下命令：
swagger2markup < swagger.json > swagger.adoc
在本地浏览器中打开 http://localhost:3000/api-docs 地址，即可看到可视化的 API 文档。
总结
通过上面的使用教程，我们可以方便地使用 swagger2 包来生成前端的 API 文档，快速生成完整的接口文档，提高我们的开发效率和代码可维护性。当你开发一个大型项目时，使用 swagger2 包将会是一个非常不错的选择。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/201890