[工具] 目录式管理swagger doc工具: swagger-dir

楼主: VdustR (京)   2020-03-16 11:28:04
大家好
因为工作环境的关系
我们总是有过多的团队、专案和版本的 swagger API docs 需要在内部分享
definition 也仅支援 array
申请机器又麻烦
希望能够集中管理
可以透过单一 swagger ui 的 url 参数来阅读 swagger API docs 以减少重复的服务
因此开发了一套 swagger-dir 提供接口浏览资料夹内的 swagger 档案
希望能够透过资料夹和档案的结构来帮助管理 swagger 文件
https://github.com/VdustR/swagger-dir/raw/master/Preview.png
- swagger-dir 用目录结构管理 swagger API 文件
- 内建 swagger-ui,直接点击连结就可以阅览 API
- 档案即时更新不需重启服务
- 支援 mac / linux 并提供 docker image
- docker for mac 执行时需加入环境变量 `CHOKIDAR_USEPOLLING=true` 使用
polling 触发 file events
https://github.com/vdustr/swagger-dir
补个 js 点
专案由 express 和 react 撰写
欢迎大家试用和提供建议
也欢迎有在使用 discord 的朋友一起聊天或是技术交流
https://ganhuaking.github.io/
谢谢 >"<

Links booklink

Contact Us: admin [ a t ] ucptt.com