手册
1. 禅道API开发手册
1.1 配置使用与常见问题
1.2 调用SDK示例
1.3. 部门相关接口
1.3.1 获取部门列表
1.3.2 批量添加部门
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. 禅道API文档v1
2.1. Token
2.1.1 获取Token
2.2. 部门
2.2.1 获取部门列表
2.2.2 获取部门详情
2.3. 用户
2.3.1 获取我的个人信息
2.3.2 获取用户列表
2.3.3 获取用户信息
2.3.4 修改用户信息
2.3.5 删除用户
2.3.6 创建用户
2.4. 项目集
2.4.1 获取项目集列表
2.4.2 修改项目集
2.4.3 获取项目集详情
2.4.4 删除项目集
2.4.5 创建项目集
2.5. 产品
2.5.1 获取产品列表
2.5.2 创建产品
2.5.3 获取产品详情
2.5.4 编辑产品
2.5.5 删除产品
2.6. 产品计划
2.6.1 获取产品计划列表
2.6.2 创建计划
2.6.3 获取计划详情
2.6.4 修改计划
2.6.5 删除计划
2.6.6 产品计划关联需求
2.6.7 产品计划取消关联需求
2.6.8 产品计划关联Bug
2.6.9 产品计划取消关联Bug
2.7. 发布
2.7.1 获取产品发布列表
2.7.2 获取项目发布列表
2.8. 需求
2.8.1 获取产品需求列表
2.8.2 获取项目需求列表
2.8.3 获取执行需求列表
2.8.4 创建需求
2.8.5 获取需求详情
2.8.6 变更需求
2.8.7 修改需求其他字段
2.8.8 删除需求
2.8.9 关闭需求
2.9. 项目
2.9.1 获取项目列表
2.9.2 创建项目
2.9.3 获取项目详情
2.9.4 修改项目
2.9.5 删除项目
2.10. 版本
2.10.1 获取项目版本列表
2.10.2 获取执行版本列表
2.10.3 创建版本
2.10.4 获取版本详情
2.10.5 修改版本
2.10.6 删除版本
2.11. 执行
2.11.1 获取项目的执行列表
2.11.2 创建执行
2.11.3 查看执行详情
2.11.4 修改执行
2.11.5 删除执行
2.12. 任务
2.12.1 获取执行任务列表
2.12.2 创建任务
2.12.3 获取任务详情
2.12.4 修改任务
2.12.5 删除任务
2.12.6 开始任务
2.12.7 暂停任务
2.12.8 继续任务
2.12.9 完成任务
2.12.10 关闭任务
2.12.11 添加任务日志
2.12.12 获取任务日志
2.13. Bug
2.13.1 获取产品Bug列表
2.13.2 创建Bug
2.13.3 获取Bug详情
2.13.4 修改Bug
2.13.5 删除Bug
2.13.6 确认Bug
2.13.7 关闭Bug
2.13.8 激活Bug
2.13.9 解决Bug
2.14. 用例
2.14.1 获取产品用例列表
2.14.2 创建用例
2.14.3 获取用例详情
2.14.4 修改用例
2.14.5 删除用例
2.14.6 执行用例
2.15. 测试单
2.15.1 获取测试单列表
2.15.2 获取项目的测试单
2.15.3 获取测试单详情
2.16. 反馈
2.16.1 创建反馈
2.16.2 指派反馈
2.16.3 关闭反馈
2.16.4 删除反馈
2.16.5 修改反馈
2.16.6 获取反馈详情
2.16.7 获取反馈列表
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版本

禅道项目管理软件打包规范1.1版本

2011-04-27 11:08:19
分享链接
摘要:这篇文章描述了禅道项目管理软件的插件打包规范。通过该规范,用户可以将他们开发的功能打包成插件并与其他人分享。文中详细介绍了插件可扩展的元素,并指出了每个目录应包含的文件和内容。此外,还提到了主配置文件的扩展方式以及安装和删除时的钩子脚本使用方法。最后,给出了创建自己插件的步骤摘要和示例链接供参考。

大家在二次开发过程中,好的功能也可以打包成插件和大家进行分享。我们整理了禅道项目管理软件打包规范。

一、可以扩展的元素:

目录 说明
bin 比如新增的命令行脚本程序。
config 比如可以对配置文件进行修改。
db db目录下面可以存放install.sql和uninstall.sql,分别对应安装时需要执行的sql脚本和卸载时需要执行的sql脚本。
doc 这个插件相关的文档。
lib 可以新增某一个类,或者对现有的类进行修改。
module 可以新增某一个模块,也可以对现有的模块进行功能扩展。
www

可以发布自己的风格。也可以对js文件进行修改。

二、doc目录应当包含的文档

doc目录下面包含了插件的配置信息,按照语言进行存储,比如英文版本的,存为en.yaml,中文zh-cn.yaml

插件的配置文件采用yaml格式,里面包含了插件的基本信息以及历次版本的发布信息。共分为下 面的信息:

可以参考:http://www.zentao.net/extension-viewExt-1-info-front.html

三、db目录下面包含的文件:

db目录下面可以包含install.sql和uninstall.sql。顾名思义,install.sql是当安装插件的时候执行的sql语句,而uninstall.sql则是当卸载插件的时候需要执行的sql语句。这样如果你的插件涉及到数据库的改动,可以将相应的sql语句放在这两个文件中,禅道的插件管理程序会自动来执行。

四、module下面的文件:

module目录下面的文件,就按照我们的插件扩展机制 部署相应的目录结构就可以了。

五、主配置文件的扩展

在实际过程中,可能会需要对全局的配置文件进行扩展,这种情况将扩展的配置文件放在zentao/config/ext/下面就可以了。

六、安装和删除的钩子脚本

如果在安装之前,安装之后,卸载之前,卸载之后需要执行一些操作,可以建立一个hook目录,然后分别在里面创建preinstall.php, postinstall.php, preuninstall.php, postuninstall.php,里面放上你所需要的代码即可。

七、小结:创建自己的插件:

  1. 确定插件的英文名,比如叫做hello。
  2. 创建hello目录。
  3. 在hello目录下面创建doc目录。
  4. 在doc目录下面创建配置文件yaml文件:
  5. 如果有涉及到数据库的改动,在hello目录下面创建db目录,分别写好install.sql和uninstall.sql
  6. 如果需要钩子脚本,创建hook目录,创建 preinstall.php, postinstall.php, preuninstall.php, postuninstall.php。
  7. 然后部署相应的扩展代码。在hello目录下面创建一个module目录,然后将相应的模块扩展代码放在module下面。
  8. 打包,使用zip格式将整个hello目录打包成hello.zip,就可以了。

八、查看示例:

请看我们示例:http://www.zentao.net/extension-viewExt-1.html

101681 王春生