禅道RESTful API开发手册v1
手册分类
- 1. 禅道SDK开发手册
- 1.1 配置使用与常见问题
- 1.2 调用SDK示例
- 1.3. 部门相关接口
- 1.4. 用户相关接口
- 1.4.1 获得添加用户所用的参数列表
- 1.4.2 添加单个用户
- 1.4.3 获取用户列表
- 1.5. 产品相关接口
- 1.5.1 获取产品列表
- 1.5.2 添加单个产品可选信息
- 1.5.3 添加单个产品
- 1.6. 项目相关接口
- 1.6.1 获取项目列表
- 1.6.2 添加单个项目可选信息
- 1.6.3 添加单个项目
- 1.7. 任务相关接口
- 1.7.1 获取任务列表
- 1.7.2 添加单个任务可选信息
- 1.7.3 添加单个任务
- 1.7.4 完成单个任务可选信息
- 1.7.5 完成单个任务
- 1.8. bug相关接口
- 1.8.1 获取Bug列表
- 1.8.2 添加单个Bug可选信息
- 1.8.3 添加单个Bug
- 1.8.4 解决单个Bug可选信息
- 1.8.5 解决单个Bug
- 2. 禅道RESTful API开发手册v1
- 3. 定制开发
- 3.1 二次开发机制
- 3.2 禅道的目录结构
- 3.3 找到要修改的文件
- 3.4 禅道的数据库结构
- 3.5 公用模块--common
- 3.6 12系列菜单登记和权限维护
- 3.7 18系列菜单登记和权限维护
- 3.8 示例:如何修改禅道的语言提示?
- 3.9 示例:创建bug时可以设置优先级字段
- 3.10 使用在线扩展编辑器
- 3.11 二次开发编辑器和翻译功能限制使用说明
- 3.12 禅道项目管理软件打包规范1.1版本
配置使用与常见问题 分享链接
作者:宋辰轩
最后编辑:宋辰轩 于 2024-08-29 14:53:55
浏览量:843
本篇目录
一、禅道版本要求
禅道 RESTful API v1 在禅道开源版 16.5 版本之后新增到禅道框架中,API 入口文件位于【禅道项目目录/www/api.php】,API 的路由解析规则位于【禅道项目目录/config/routes.php】
二、使用说明与示例
2.1以获取1号产品的bug列表举例
(1)保证账号有查看1号产品的bug访问权限(权限调整可以在后台-人员管理-权限中进行调整,具体可以参考文档 https://www.zentao.net/book/zentaopms/1010.html)
(2)请求 zentaourl/api.php/v1/tokens 接口获取 token,以 curl 命令举例如下,Header 中设定 Content-Type 为 application/json ,data 中设定用户对应的 account 和 password
curl -X POST "zentaourl/api.php/v1/tokens" -H "Content-Type: application/json" -d '{"account": "admin", "password": "adminpassword"}'
获得返回结果举例如下:
{"token":"xxxxx62e16b45kndlxxxxx"}
2.2使用返回的 token 获取1号产品的 bug 列表
请求其他接口时(非tokens接口),需要在 Header 中添加一个名为 Token 的键,其值为你刚刚获取的 token,以获取产品ID为1的bug列表举例,curl 命令如下
curl -X GET "zentaourl/api.php/v1/products/1/bugs" -H "Token: xxxxx62e16b45kndlxxxxx" -H "Content-Type: application/json"
获得的结果举例如下:
{"page":1,"total":0,"limit":20,"bugs":[]}
三、常见问题
3.1返回 error:not found
获得的结果举例如下:{"error":"not found"}没有找到对应的 API,请检查 url 拼写是否正确