功能入口

入口
在服务列表界面,点击某个服务的 API管理 操作,进入到该服务的API列表界面。
可以对API文档进行 查看详情 编辑 删除 变更类别标签 等操作

API列表

API文档列表

新建API文档

点击 新建API ,进入新建API文档界面
新建API文档

基本信息

在API文档中填写 请求方法 路径地址 API描述 类别 请求信息 响应信息
请求方法

请求方法 :通过下拉列表进行选择,比如GET、POST、PUT等。

路径地址 :输入API的URL,或者您已经设置好了模块环境,可以直接在这里填写path。

API描述 :填写API描述,帮助您的团队其他人理解该API。

类别 :通过选择类别,对API文档进行分类。一个API可以选择多个类别。

类别

请求信息

请求头

请求头

请求体

支持两种模式:1、Form-data 2、Json

请求体

请求参数

请求参数

REST参数

REST参数是请求地址栏被斜杠/分隔的参数

REST参数

填写响应参数

响应头

响应信息-响应头

响应体

目前提供Json类型

响应体

类别管理

在API文档列表,点击添加,新增类别

新建类别按钮

同时,您也可以对类别进行 修改、删除

修改类别

类别弹窗

API关联用例

在接口API详情中可以查看接口关联的用例。

API关联用例
查看关联用例列表

API关联用例详情
查看关联用例详情