Trantor 元信息文档
Flow、Func Swagger文档
配置
在业务域中开发的flow 、function Trantor会自动生成Swagger文档，因为是基于元信息的，所以swagger文档的主入口在运行态的MetaStore中。出于安全考虑，Swaager的开关默认是关闭的，需通过环境变量的方式开启。
Swagger 访问地址：https://${metatore-address}/swagger-doc/swagger-ui.html
将访问地址中
${metastore-address}替换为真实运行态的meta-store域名
| 环境变量Key | 默认值 | 备注 |
|---|---|---|
| SWAGGER_ENABLED | false | swagger是否开启 |
| SWAGGER_INCLUDE_MODULES | 默认情况下没有值，会加载已有业务域下的所有flow/func。 | 指定需要展示的模块，配置对应的模块key(trantor.yml中查看)即可。多个模块以 英文逗号 分隔。 |
当开启
SWAGGER_ENABLED时，强烈推荐配置上SWAGGER_INCLUDE_MODULES。因为模块太多会导致整个加载变慢，甚至卡死。!!! 以上环境变配置在
运行态 meta-store中。配置展示多个模块时以英文逗号分隔，逗号间不要加空格!!!!!! 以上环境变配置在
运行态 meta-store中。配置展示多个模块时以英文逗号分隔，逗号间不要加空格!!!!!! 以上环境变配置在
运行态 meta-store中。配置展示多个模块时以英文逗号分隔，逗号间不要加空格!!!
示例
LogicController Swagger文档
配置
Trantor 1.0 新增了 logicController 的数据请求方式，这种请求方式在使用上面也更加的灵活，该机制不会在数据库存在具体的元信息数据，是通过在应用启动时通过 Bean 对象后置处理器收集元信息数据，通过映射的方式调用的。 因此，这部分的 swagger 文档是展示在具体的服务上的，而不是像 Flow 和 Func 可以在 Metastore 上直接访问。
Swagger 访问地址：https://${runtime-address}/trantor-swagger-doc/swagger-ui.html
将访问地址中
${runtime-address}替换为对应业务应用的 runtime 域名
| 环境变量Key | 默认值 | 备注 |
|---|---|---|
| SWAGGER_ENABLED | false | swagger是否开启，需要同时在运行态 Metastore 和业务服务同时配置 |
说明：目前 api 展示仅支持出入参为 model、List<Model> 和 Paging<Model> 类型。
示例
元数据信息 Markdown文档
使用方式
在研发态 MS 研发中心 配置 下的 业务域 页面，在操作处点击 下载MD文档即可：
示例
