1. 后台测试
  2. 服务管理
  3. 接口文档

接口文档

按照版本管理接口相关信息,支持多种接口导入方式,方便多版本并行开发测试。

功能入口

左侧导航进入服务管理,点击“接口文档数量”

文档版本管理

新建版本

点击“+”

填写版本号版本描述,点击“保存”按钮

替换当前版本

点击“替换当前版本”

当前版本又1.0.3切换成1.0.4

接口列表的接口会自动同步1.0.4版本下的接口,之前版本的接口自动转成归档接口

HTTP接口文档

新建接口


填写接口相关参数

点击调试按钮

输入host地址,点击调试按钮

接口录制

点击接口录制

选择指定类型

安装浏览器录制插件

导入接口

支持Swagger(2.0和3.0,推荐使用3.0)和Postman(Collection v2.1)文档导入
点击“导入接口”,选择文件类型、目标文件和覆盖方式

导出接口

点击“导出接口”,平台会自动将指定版本下的所有接口生成swagger文件自动下载。

Dubbo接口文档

针对Dubbo协议,支持手动输入接口信息。

新建接口

点击“新建接口”按钮如下图所示

填写接口名称、方法名称、请求信息和响应信息等。通过点击“插入子项”添加JSON数据类型

接口详情

点击API描述,可查看接口详细信息

详情展示如下图所示

RPC接口文档

上传协议文件

点击“上传协议文件”按钮,平台会自动解析接口和结构体

点击“API”描述,可查看接口详情如下