Appearance
一个ApiRegister(OpenAPI数据源实例)是最终文档展现的最小单元,ApiRegister隶属于Namespace
主要包含的字段:
- namespaceId:归属那一个namespace
- app-name:当前API服务的名称
- 服务名称:API服务中文名称
- 规范类别:OpenAPI规范的类别,主要是
OpenAPI3
、Swagger2
、AsyncAPI
(未来将支持) - 调试Proxy:文档最终调试时,代理的HTTP目标服务地址
- 描述信息:API服务的简介信息
- 数据资源类型:
HTTP接口
、Editor编辑器
- 数据来源地址:
HTTP接口
类型则是OpenAPI数据源的完整URL地址,Editor编辑器
类型则是OpenAPI规范数据包
文档预览
在ApiRegister列表中,点击数据中的链接地址,即可在线查看文档
HTTP接口模式
接口模式,填写地址即可
如下图:
Editor编辑器模式
Editor编辑器模式则是将OpenAPI数据源贴进来,可以进行编辑修改
支持JSON
、YAML
两种模式
如下图: