fugary/simple-api-doc repository overview

⁠simple-api-doc

最近使用新OpenAPI接口时发现自带的SwaggerUI界面不是很友好，一些开源的库，如Knife4j使用虽然很方便，不过对于比较大的schema支持不好，容易出现卡顿，目前做的比较好的是ApiFox，不过不能同步Markdown文件，而且私有化部署需要另外收费。

其实API文档服务比较简单，没有太多功能，因此抽空自己开发一个简单的API文档系统

⁠功能介绍

由一个Java后端和Vue3前端组成，主要功能如下：

1. 从Swagger或者OpenAPI的文档（json/yaml)文件或URL路径导入文档系统
2. 支持查看Markdown文档和API文档字段等
3. 支持新增Markdown文档，方便对OpenAPI文档做一些附加说明等
4. 支持分享链接和密码查看，支持分享有效期
5. 支持定时从指定URL抓取文档数据
6. 支持在线调试接口请求
7. 支持多级文件夹展示API文档

⁠Docker安装

docker运行比较简单，只要已经安装好docker，直接使用命令就可以自动拉去镜像并运行了

docker run -p 9089:9089 fugary/simple-api-doc:latest

启动后可以进入登录页面：http://localhost:9089/⁠ 默认账号密码：admin/12345678

⁠截图示例

参考文档： https://fugary.com/?p=636⁠