[工具] 目錄式管理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