dms/sqle支持统一的swagger server服务

[rocky114]

现状

当前API接口仅在代码中提供了swag.json文件，没有在线swag server 服务

预期

部署服务后，同时提供在线swag server

实现方案

方案一

dms/sqle生成一个swagger文档

优点： 在线swagger服务配置简单，组件文档以一个文档形式展示
缺点： 需要使用脚本合并dms/sqle组件的文档,swagger无合并swagger文档特性且合并文档耦合高,难以维护

方案二

dms/sqle各自生成swagger文档

优点： 文档以下拉框形式选择查看不同组件的文档，dms/sqle组件生成文档的脚本保持不变
缺点： 需要修改swagger服务初始化参数,打包流程繁琐,开发debug调试阶段无法更新swagger文档,只有再次重新打包才能更新swagger文档

方案三

sqle新增获取swagger.yaml文件接口,dms调用该接口获取sqle的swagger.yaml文件

最终效果:

右上角选择dms/sqle:

通过swgger server调用dms登录接口

通过swgger server调用sqle白名单GET接口

使用方式

填入token后即可正常调用接口(dms/sqle使用方式相同)

总结

方案三最简单明了,实现成本低,方案一和方案二实现复杂且都存在各自的缺点,综上,最终选择方案三.

todo-list

• sqle新增获取swagger.yaml文件GET接口 4h
• dms新增swagger接口 8h
• 解决点击浏览器刷新404的问题 4h

影响面：

sqle新增 @basepath /sqle 基础api前缀,调用sqle接口时,需要新增 /sqle 前缀,只对swagger调用有影响,对系统集成无影响

// @title Sqle API Docs
// @version 1.0
// @description This is a sample server for dev.
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name Authorization
// @BasePath /sqle