1  15版本禅道的安装升级
2  15版本禅道的新增功能
3  15版本禅道的界面变化
4  15版本禅道的最简使用
5. 15版本禅道的基本使用
5.1  新手引导
5.2  全局添加
5.3  接口库
5.4  配置飞书内的禅道单点登录
6. 按照角色使用15版本禅道
6.1. 管理员
6.1.1  维护组织部门
6.1.2  维护用户
6.1.3  维护权限
6.2. 项目集负责人
6.2.1  创建项目集
6.2.2  关联产品
6.2.3  创建项目
6.2.4  管理人员
6.2.5  添加干系人
6.3. 产品经理
6.3.1  创建产品
6.3.2  维护模块
6.3.3  维护计划
6.3.4  维护需求
6.3.5  需求的评审
6.3.6  创建发布
6.3.7  跟踪进度
6.4. 项目经理
6.4.1  维护项目和执行
6.4.2  维护团队
6.4.3  关联需求
6.4.4  分解任务
6.4.5  跟踪进度
6.5. 研发人员
6.5.1  领取任务和BUG
6.5.2  更新状态
6.5.3  完成任务和BUG
6.5.4  提交代码
6.5.5  执行的综合、需求、Bug、任务看板
6.6. 测试人员
6.6.1  撰写用例
6.6.2  执行用例
6.6.3  提交BUG
6.6.4  验证和关闭BUG
7. DevOps 功能
7.1. 集成GitLab
7.1.1  集成GitLab,绑定用户,关联issue,进行构建
7.1.2  集成GitLab,提交合并请求
7.1.3  禅道中GitLab的权限
7.2  集成Jenkins,进行构建
7.3  集成SonarQube
8  通用看板功能
9. 后台设置
9.1  客户端
9.2  模型
9.3  自定义
9.4. 通知
9.4.1  邮件
9.4.2  Webhook
9.4.3  浏览器
9.4.4  设置
9.5  插件
9.6  二次开发
9.7  系统
9.8  登记菜单和权限
10. 权限维护和访问控制
10.1  项目集的权限维护和访问控制
10.2  产品的权限维护和访问控制
10.3  项目的权限维护和访问控制
10.4  执行的权限维护和访问控制
10.5  项目和执行的访问控制和数据关系

接口库

2021-10-29 10:52:58
先知
3412
最后编辑:Renee 于 2021-11-11 13:07:01
分享链接
禅道开源版15.7版本,文档视图下新增了接口库文档功能。

可以在这里管理接口文档、数据结构。
接下来我们来具体介绍接口库的使用。

一、分配权限

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


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

权限分配可以灵活按照实际工作需要来分配。

二、维护接口库

1、创建接口库

点击接口库--文档页面右上角的创建按钮,即可进入接口库创建页面。

创建接口库页面可以设置请求基路经,接口库的访问控制。


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

2、维护接口库目录
点击目录右上角的更多图标的维护目录,进入维护接口库的维护目录。

按照使用需要添加接口库的目录后,点击保存即可。

再次进入维护目录页面,可以对目录进行排序,编辑删除,添加子目录的操作。

3、编辑和删除接口库
同样是点击目录右上角的更多图标,点击下拉中的编辑接口库和删除接口库按钮进行操作。

编辑接口库页面:

删除接口库的确认页面:

三、维护接口

维护接口库的目录后,我们就可以添加接口库文档了。
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、全屏和删除接口
同样在接口的详情页面,点击全屏查看按钮,可以全屏查看接口文档。

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

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

创建接口发布版本页面:


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

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


四、维护数据结构

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

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

创建数据结构页面:

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

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

发表评论
评论通过审核后显示。