文档

接口文档 分享链接

作者:wulina 最后编辑:刘振华 于 2024-12-11 14:28:05 浏览量:19480

【15.7版本起】文档视图下新增了接口库文档功能。可以在这里管理接口文档、数据结构。

【18.4版本起】文档中新增接口空间,可以在接口空间中创建某项目或产品下的接口文档,也可以在接口空间查看对应项目或产品下的的接口库和接口文档。

【21.1版本起】文档接口空间中新增了首页,在接口空间首页中可以查看独立接口库、产品接口和项目接口。进入库或项目/产品后可以查看库下的数据结构、接口版本、目录和文档。

接下来我们来具体介绍接口库的使用。可观看视频了解操作详情:https://www.zentao.net/redirect-index-20658.html


一、分配权限

1、文档权限【15.7版本起】

首先需要分配查看和操作权限,权限分配可以灵活按照实际工作需要来分配。

到后台--人员--权限里,分配以下截图的权限即可。

2、文档权限【18.4版本起】

在后台--人员管理--权限--接口管理中分配对应的权限。


二、维护接口文档【21.1版本】

1、创建接口

在接口文档列表页中,点击创建接口,可以在这里创建接口。


2、维护接口

进入接口文档详情页中,点击编辑和删除可以维护接口。


三、维护数据结构【21.1版本】

1、创建数据结构

在接口空间中库的列表页,点击左侧树形导航中的数据结构,点击右上角的创建数据结构按钮可以创建数据结构。

2、维护数据结构

在数据结构列表页中,可以编辑数据结构表单或删除。

四、版本管理【21.1版本】

1、发布接口

在接口空间中库的列表页,点击左侧树形导航中的版本管理,点击右上角的发布接口可以发布接口。

2、维护版本

在版本管理列表页中,可以删除已发布的接口。

五、维护接口【15.7版本起】

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

1、创建接口

点击页面中间的创建接口按钮,或者是右上角的创建按钮,都可以进入创建接口文档的页面。

创建接口页面,需要填写的内容稍微多一些。
所属接口库:可以在下拉里选择所属的接口库
目录:所属接口库的目录,也可以在下拉里进行选择
请求路径:目前支持 HTTP 和 HTTPS , GET、POST、PUT、DELETE、PACTH、OPTIONS、HEAD
请求格式:application/json , application/x-www-form-urluncoded ,multipart/form-data
开发状态:开发完成、开发中、不显示
负责人:负责该接口的人员
请求头:接口的请求头字段
请求参数:接口的请求参数字段

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

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

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

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

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

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

2、编辑接口

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

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


3、全屏和删除接口

同样在接口的详情页面,点击全屏查看按钮,可以全屏查看接口文档。


点击详情页的删除按钮,删除接口的确认页面。

六、其他【15.7版本起】

1、维护数据结构

接下来我们介绍数据结构功能。

点击页面右上角的创建数据结构按钮,进入添加数据结构页面。

创建数据结构页面:

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

创建成功的数据结构可以在列表里查看。
还可以通过操作按钮进行编辑和删除操作。

2、发布接口

发布接口,可以对接口文档进行版本管理。
点击右上角的发布接口按钮,可以进入发布接口的版本创建页面。


创建接口发布版本页面:


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

3、版本管理

发布接口后,还可以在目录右上角的更多按钮,进行版本管理。
在这里可以查看已发布的版本和删除不需要的版本。


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