文档

接口空间 分享链接

作者:wulina 最后编辑:乌丽娜 于 2023-05-08 09:08:26 浏览量:8966
文档模块在18.4版本全新升级,新增了接口空间,支持创建接口库和接口文档。

可以在接口空间中管理接口库和文档、数据结构、版本管理及发布接口。
接下来我们来具体介绍接口空间如何使用


一、分配权限

首先需要分配接口空间的相关操作权限。

到后台--人员管理--权限里的接口管理部分,分配对应的权限即可,权限分配可以灵活按照实际工作需要来分配。

二、维护接口库

1、创建接口库

点击文档--接口空间--创建库的按钮,可以创建接口库。

在创建库的弹窗中,可设置请求基础路经、接口库的访问控制。支持创建独立接口库、产品接口库以及项目接口库。

选择私有权限后,可设置白名单用户。

接口库创建成功后,可以在左上角的接口库下拉组件里查看到。
创建接口库成功后,我们就可以对接口库进行目录、版本管理、编辑和删除接口库操作。

2、查看某产品或某项目下的接口库或文档

可选择产品或项目,查看其下的接口库和文档。

3、维护接口库目录

鼠标悬浮到某接口库上,点击右侧出现的更多按钮,可添加目录、编辑库和删除库。

鼠标悬浮到某接口库下文档时,点击右侧出现的更多按钮,可添加同级目录、添加子目录、编辑目录和删除目录。

编辑接口库:点击下拉菜单中的编辑接口库和编辑目录按钮。

删除接口库:点击下拉菜单中的删除接口库和删除目录按钮。
删除接口库和删除目录会出现二次确认的弹窗

三、维护接口

维护好接口库的目录后,我们就可以添加接口库文档了。
1、创建接口

点击文档--接口空间--创建接口的按钮,可以创建接口文档。

当接口库下没有接口文档时,也可在页面中点击创建接口按钮。

在创建接口页面中,可填写内容如下:
所属接口库:默认不可更改
目录:可在下拉菜单中选择所属接口库的目录
请求路径:目前支持 HTTP、HTTPS、WS和WSS , GET、POST、PUT、DELETE、PACTH、OPTIONS、HEAD
请求格式:application/json , application/x-www-form-urluncoded ,multipart/form-data
开发状态:开发完成、开发中、不显示
负责人:负责该接口的人员
请求头:接口的请求头字段
请求参数:接口的请求参数字段

请求体:有4种类型:FormData,JSON,Array,Object
选择了类型后,可以根据类型填写字段名、字段类型、是否必填、描述。

以及给字段添加子字段,对字段、子字段进行添加和删除操作。

请求示例:根据请求体,给出一个请求示例。

请求响应:填写该接口的响应字段、字段类型、是否必填、描述、添加子字段等操作。

响应示例:根据接口的请求响应字段,编写一个响应示例。
描述:对接口的简要介绍。

填写完接口的信息,点击保存,即可在接口列表查看到添加成功的接口。
可以查看接口的开发状态,请求路径。

2、编辑接口

接口列表详情中,点击右上角的编辑按钮,进入编辑接口页面。

编辑接口页面:
需要注意的是,编辑接口不能更改所属的接口库。

3、全屏和删除接口
点击全屏按钮,可以全屏查看接口文档。

点击删除按钮,可以删除接口,需二次确认。

四、发布接口

点击发布接口按钮,进入发布接口的版本创建页面,可以发布接口

创建接口发布版本:


发布接口成功后,可以切换版本来查看接口文档。

五、版本管理

点击版本管理按钮,可以对接口文档进行版本管理,查看已发布的版本和删除不需要的版本。

六、维护数据结构

点击数据结构按钮,进入数据结构列表页面。

在数据结构列表页,可以创建数据结构。

在创建数据结构页面,填写数据结构的名称,类型和字段和描述即可。

创建成功的数据结构在数据结构列表里显示,可查看、编辑和删除。

七、导出文档

点击页面右上方的导出按钮,可以选择导出范围是「列表中接口文档」或者「未关联产品和项目的所有接口文档」,文档类型为word,编码为UTF-8,导出格式仅支持导出为合并为一个文档。


返回顶部
徐亚京
高级客户经理
17663982076
2679672214
统一服务热线 4006-8899-23
我要提问提问有任何问题,您都可以在这里提问。 问题反馈反馈点击这里,让我们聆听您的建议与反馈。