在前端开发中，我们经常需要编写接口文档以及对接口进行测试。但是手动编写这些文档和测试代码往往是很繁琐和费时的。为了提高效率，我们可以使用 npm 包 swagger-decorator。
安装 swagger-decorator
使用 npm 进行安装：
npm install swagger-decorator --save-dev
配置 swagger-decorator
首先，在应用程序中定义 swagger 基础信息，并引入 swagger-decorator 模块：
-- -------------------- ---- -------
------ - -------------- --------------- - ---- ------------------
------ - --------- - ---- ---------------
----- -------- ----------- -
----- --- - ----- ------------------------------
----- ------- - --- -----------------
-------------- ----
-------------------- ----
------------------
---------------
---------
----- -------- - --------------------------------- ---------
------------------------------- ---- ----------
----- -----------------
-
------------然后，在每个 API 控制器中使用 swagger-decorator 进行装饰：
-- -------------------- ---- -------
------ - ----------- --- - ---- -----------------
------ - -------- ------------ ------------ - ---- ------------------
------------------
----------------
------ ----- ------------- -
------
-------------- ------- ---- ------------ ------ --
--------------- -------- ------ ------------ -------- --
----- ---------- ------------ -
-- ------
------ ---
-
-在浏览器中访问 API 文档
启动应用程序后，在浏览器中访问 http://localhost:3000/api-docs，即可看到自动生成的 API 文档。如下图所示：
swagger-decorator 示例
-- -------------------- ---- -------
------ - ----------- ---- ----- ----- ----- - ---- -----------------
------ - -------- ------------ ------------ - ---- ------------------
------------------
----------------
------ ----- ------------- -
-----------
-------------- ------- ---- ------------ ------ --
-------------- ------- ---- ------------ ------- --
--------------- -------- ------- ------------ --- -- ----- --
----- -------------------- --- -------- ------------ -
-- ------
------ - -- --
-
-------
-------------- ------- ---- ------------ ------ --
-------------- ------- ---- ------------ ------ --
--------------- -------- ------- ------------ ---------- --
----- -------------- ----- ----- ------------ -
-- ----
------ -----
-
-总结
使用 swagger-decorator 可以大大提高前端开发中接口文档和测试代码的编写效率。在应用程序中配置 swagger 基础信息，并在每个 API 控制器中使用 swagger-decorator 装饰器，即可自动生成 API 文档。同时，swagger-decorator 还提供了丰富的装饰器选项，方便我们编写标准的 API 文档和测试代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055d2781e8991b448dade1