在日常的前端开发中，接口的设计和文档的撰写是重要的工作内容。本文将介绍一款针对 Egg.js 框架的 npm 包 @lynzz/egg-swagger-decorator，提供接口的自动生成以及文档的在线展示功能，并具有简单易用、配置灵活等优点。
适用环境
@lynzz/egg-swagger-decorator 适用于以下场景：
- 基于 Egg.js 开发的后端项目
- 接口文档需求量大，文档的自动生成、在线展示等方面需要提高工作效率
- 希望使用一款简单易用且灵活配置的 Swagger 包
安装和配置
使用 npm 进行安装：
$ npm i @lynzz/egg-swagger-decorator --save
在 Egg.js 的 config.default.js 中进行配置：
-- -------------------- ---- ------- -- ----------------- ------------------ - - ----------- ------------------- -------- - ------ -------------- ------------ ----------- --- ----- -------- -------- -- -------- -------- --------- --------- --------------------- --------- --------------------- -------------------- - ------- - ----- --------- ----- ------------ --- --------- -- ---- - ----- --------- ----- ---------------- --- --------- -- -- --------------- ----- ---------- ----- ------- ----- --在 Egg.js 的 config/plugin.js 中进行配置：
// config/plugin.js exports.swaggerdoc = { enable: true, package: '@lynzz/egg-swagger-decorator', };
使用教程
在需要生成接口文档的 controller 中进行装饰器的设置：
-- -------------------- ---- ------- -- ---------------------- ----- - ---------- - - --------------- ----- - ---- ----- ------ ----- ------- - - ---------------------------------------- ----- -------------- ------- ---------- - --- - ------ ------------- --- - --- ------- -- ---------------- - ----------- - --- - -------- -- -- ------ - ------- --- ----------------- - -------- ---- - --------- --- ------------ ------ -- ---------- ------- --- - ----- --------- --------- ----- ------------ --- --- - -- -------- ------- - ----- --------- -------- -- ------------ ------- --------- ------ ----- --- -- --- -- -- ------------------ ----- --------- - ----- - --- - - ----- ----- - --- ------ - - ------------------ ----- -------- - ----- ------------------------------ --- ------ --- -------- - - ----- ---- ----- --------- -------- ----- -------- ----------- -- - --- - -------- ---- - ------- ---- ------------ - -------- ---- - --------- --- ------------ ----------- -- ---------- ------- ----- - ----- --------- --------- ----- -------- ------- ------------ ----- -- ---- - ----- --------- --------- ----- -------- ----- ------------ ------ -- ------- - ----- --------- ------------ ------- --------- ------ ----- --- -- -- -- -- ---------------- ----- ------------ - ----- - --- - - ----- ----- - ----- ---- ------ - - ----------------- ----- -------- - ----- ----------------------------- ----- ---- ------ --- ---------- - ---- -------- - - ----- ---- ----- --------- -------- --------- -------- ----- -- - - -------------- - ---------------
总结
@lynzz/egg-swagger-decorator 是一款针对 Egg.js 项目的 Swagger 包，具有自动生成接口文档以及在线查看文档的功能。使用该包可以提高项目开发效率，让开发者更加专注于接口功能的开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066b6051ab1864dac672b6