

- 1. 禅道介紹
- 1.1 关于禅道項目管理软件
- 1.2 如何獲得支持
- 1.3 各版本功能差異
- 1.4 關注我們
- 2. 安裝禅道
- 2.1. 環境搭建
- 2.1.1 搭建Ubuntu環境安裝禅道
- 2.1.2 搭建Centos環境安裝禅道
- 2.1.3 安裝PHP的ioncube擴展
- 2.2. 安裝禅道
- 2.2.1 選擇適合您的安裝方法
- 2.2.2 新版本禅道的安裝升級
- 2.2.3 Windows一鍵安裝包(新版)
- 2.2.4 Windows一鍵安裝包(舊版)
- 2.2.5 linux用一鍵安裝包(推薦)
- 2.2.6 使用源碼包安裝(各系統通用)
- 2.2.7 使用源碼包安裝(MAC系統)
- 2.2.8 基于禅道當前的一鍵安裝包(Windows和Linux)如何源碼安裝旗艦版禅道
- 2.2.9 渠成命令行安裝禅道
- 2.2.10 Docker和Kubernetes方式部署禅道
- 2.3 安裝PHP的LDAP擴展
- 2.4 在线安装雲禅道
- 2.5 安装 APCu扩展
- 2.6 安裝DuckDB引擎
- 2.7. 信創支持
- 2.7.1 OceanBase數據庫
- 2.8. 安装文檔协同服務
- 2.8.1 安装Windows协同服務
- 2.8.2 安装Linux协同服務
- 2.1. 環境搭建
- 3. 升級禅道
- 3.1. 升級禅道新版本
- 3.1.1 選擇和自己環境對應的升級方式
- 3.1.2 通過源代碼方式升級(通用)
- 3.1.3 windows一鍵安裝包的升級
- 3.1.4 linux一鍵安裝包升級
- 3.1.5 docker安裝禅道-升級禅道
- 3.1.6 舊版Docker鏡像升級說明
- 3.1.7 通過Roadrunner管理定時任務
- 3.2 如何安裝ioncube擴展
- 3.1. 升級禅道新版本
- 4. 維護配置
- 4.1. 維護禅道
- 4.1.1 初始化管理腳本
- 4.1.2 備份禅道
- 4.1.3 恢複刪除的資源
- 4.1.4 如何更新燃盡圖
- 4.1.5 一鍵安裝包如何實現mysql異機連接
- 4.1.6 linux一鍵安裝包配置https
- 4.1.7 禅道一鍵安裝包遷移/更新禅道一鍵安裝包
- 4.2. 配置禅道
- 4.2.1 設置是否允許匿名訪問
- 4.2.2 如何配置email發信
- 4.2.3 如何成爲超級管理員
- 4.2.4 配置禅道系統爲靜態訪問
- 4.2.5 去掉禅道訪問地址中的zentao
- 4.2.6 linux一键安装包去掉禅道訪問地址中的zentao
- 4.2.7 集成禅道和svn
- 4.2.8 集成禅道和git
- 4.2.9 在第三方應用中集成禅道
- 4.2.10 第三方應用配置免密登錄禅道
- 4.2.11 第三方應用集成禅道客戶端進行消息通知
- 4.2.12 集成webhook
- 4.2.13 集成ZDOO
- 4.2.14 客戶端集成
- 4.2.15 浏覽器通知的設置
- 4.2.16 集成釘釘工作消息通知
- 4.2.17 集成企業微信應用消息通知
- 4.2.18 集成企業微信群機器人
- 4.2.19 集成飛書群機器人
- 4.2.20 集成飛書消息通知
- 4.2.21 解決一鍵安裝包密碼口令弱的問題
- 4.3. 性能優化
- 4.3.1 nginx反向代理禅道502或504bad gateway错误
- 4.3.2 linux系統中配置session使用redis
- 4.3.3 緩存功能
- 4.1. 維護禅道
- 5. 快速入門
- 5.1. 新版本快速入門
- 5.1.1 20版本禅道的新增功能
- 5.1.2 新版本禅道的最簡使用
- 5.1.3 20版本禅道的界面變化
- 5.1. 新版本快速入門
- 6. 按照角色使用
- 6.1. 管理員
- 6.2. 項目集負責人
- 6.3. 産品经理
- 6.3.1 維護模塊
- 6.3.2 産品多分支/平台管理
- 6.3.3 維護計劃
- 6.3.4 維護需求
- 7.4.5 需求的狀態和研發階段
- 6.3.6 創建發布
- 6.3.7 跟蹤進度
- 6.3.8 反饋管理(企业版)
- 6.4. 項目經理
- 6.5. 研發人員
- 6.5.1 参加産品计划會議,分解任务
- 6.5.2 領取任務,並每天更新任務
- 6.5.3 創建構建,提交測試
- 6.5.4 確認Bug,解決Bug
- 6.5.5 執行的綜合、需求、Bug、任務看板
- 6.6. 測試人員
- 7. 功能介紹
- 7.1. 核心管理結構
- 7.1.1 項目集(Program)
- 7.1.2 項目(Project)
- 7.1.3 産品(Product)
- 7.1.4 執行(Execution)
- 7.1.5 管理模型
- 7.2. 地盤
- 7.3. 項目集
- 7.4. 産品
- 7.4.1 创建産品
- 7.4.2 維護模塊
- 7.4.3 産品多分支/平台管理
- 7.4.4 維護計劃
- 7.4.5 維護需求
- 7.4.6 需求的評審
- 7.4.7 需求的狀態和研發階段
- 7.4.8 創建發布
- 7.4.9 跟蹤進度
- 7.4.10 業務需求&需求多層級
- 7.5. 項目
- 7.6. 執行
- 7.6.1 参加産品计划會議,分解任务
- 7.6.2 領取任務,並每天更新任務
- 7.6.3 創建構建,提交測試
- 7.6.4 確認Bug,解決Bug
- 7.6.5 執行的綜合、需求、Bug、任務看板
- 7.7. 測試
- 7.8. 自動化測試
- 7.9 DevOps(解決方案)
- 7.10. 文檔
- 7.11. AI
- 7.11.1 AI小程序簡介
- 7.11.2 創建與設計AI小程序
- 7.11.3 發布與禁用小程序
- 7.11.4 調試AI小程序
- 7.11.5 前台小程序的應用
- 7.11.6 AI小程序的導入導出
- 7.11.7 管理AI小程序權限
- 7.12. BI
- 7.12.1 維度(企業版8.4+)
- 7.12.2 大屏(企業版8.4+)
- 7.12.3 透視表
- 7.12.4 透視表下钻
- 7.12.5. 大屏設計器
- 7.12.5.1 大屏設計器界面布局
- 7.12.5.2 大屏設計器引用圖表
- 7.12.5.3 大屏设计器引用透視表
- 7.12.6 圖表
- 7.12.7. 度量項
- 7.12.7.1 查看度量項
- 7.12.7.2 創建度量項
- 7.12.7.3 度量項編碼開發操作手冊
- 7.12.8 數據表(企業版8.4+)
- 7.13. 反饋
- 7.14. 看板
- 7.14.1 通用看板功能
- 7.15. 工作流
- 7.16. 學堂
- 7.17. 資産庫(旗艦版)
- 7.17.1 資産庫管理(旗舰版)
- 7.18. 組織
- 7.18.1 團隊成員和工作信息
- 7.18.2 人力資源日曆(需安裝插件)
- 7.18.3 组织動態
- 7.18.4 公司信息
- 7.19. 辦公
- 7.20. 後台設置
- 7.20.1 後台首頁
- 7.20.2. 系統設置
- 7.20.3 功能開關
- 7.20.4. 人員管理
- 7.20.5. 模型配置
- 7.20.6. 功能配置
- 7.20.7 文檔模板
- 7.20.8. 通知設置
- 7.20.9 插件管理
- 7.20.10 二次開發
- 7.20.11 Jira數據導入
- 7.20.12 Jira數據導入--数据迁移说明
- 7.20.13 Confluence數據導入
- 7.20.14. 權限維護和控制
- 7.20.14.1 項目集的權限維護和訪問控制
- 7.20.14.2 産品的权限维护和访问控制
- 7.20.14.3 項目的權限維護和訪問控制
- 7.20.14.4 執行的权限维护和访问控制
- 7.20.14.5 项目和執行的访问控制和数据关系
- 7.20.15. AI配置
- 7.20.16. DevOps設置
- 7.20.16.1. 資源
- 7.21. 客户端增强版會議SRS
- 7.21.1. 音視頻會議配置
- 7.21.1.1 安装音視頻服務端
- 7.21.1.2 安装SRS音視頻服務端
- 7.21.1.3 开启和配置音視頻功能
- 7.21.2. 发起會議
- 7.21.2.1 一对一会话中发起音視頻會議
- 7.21.2.2 群组会话中发起音視頻會議
- 7.21.2.3 独立发起音視頻會議入口
- 7.21.3. 加入會議
- 7.21.3.1 分享音視頻會議到会话
- 7.21.3.2 通过會議的ID加入會議
- 7.21.4. 预约會議
- 7.21.4.1 预约會議
- 7.21.5. 會議应用
- 7.21.5.1 音視頻會議应用
- 7.21.1. 音視頻會議配置
- 7.22. 客户端增强版會議Jitsi
- 7.1. 核心管理結構
- 8. AI插件
- 8.1 AI插件安裝
- 8.2 ZAI服務安装
- 8.3 AI插件功能使用
- 8.4 ZAI服務控制面板使用
- 9. 其他相關
- 9.1. 其他
- 9.1.1 禅道所使用到的第三方代碼
- 9.1.2 禅道FAQ
- 9.1.3 如何幫助禅道项目
- 9.1.4 禅道商业服務
- 9.1.5 禅道項目的貢獻者
- 9.1.6 曆史修改記錄
- 9.1.7 禅道對象名稱的重名規則
- 9.1. 其他
- 10. IPD版本功能介紹
- 10.1. 禅道IPD版介紹
- 10.1.1 關于禅道IPD版
- 10.1.2 禅道IPD版的核心流程
- 10.2. IPD版的安裝和升級
- 10.2.1 選擇適合您的安裝方法
- 10.2.2 選擇適合您的升級方法
- 10.3. 需求与市場管理界面
- 10.4. IPD研發管理界面
- 10.1. 禅道IPD版介紹
接口空間 分享鏈接 /book/zentaopms/1040.html?releaseID=21
本篇目錄
【18.4版本起】文檔中新增接口空間,可以在接口空間中创建某项目或産品下的接口文檔,也可以在接口空間查看对应项目或産品下的的接口库和接口文檔。也可以在接口空間中管理接口库和文檔、数据结构、版本管理及发布接口。
【21.1版本起】在接口空間中新增了首頁,在接口空間首頁中可以查看独立接口庫、産品接口和项目接口。进入库或项目/産品后可以查看库下的数据结构、接口版本、目錄和文檔。
接下来我们来具体介绍接口空間如何使用
一、分配權限
1、空間的浏覽權限
在后台--人员管理--权限--接口管理--浏览文檔中分配对应的权限,权限分配可以灵活按照实际工作需要来分配。文檔接口相关权限均可在这里完成维护。
2、空間的操作權限
在後台--人員管理--權限--接口管理--創建與維護接口中分配對應的權限,權限分配可以靈活按照實際工作需要來分配。
文檔接口相关权限均可在这里完成维护。
二、維護空間首頁【20.8版本起】
1、查看空間首頁
点击二级导航接口空間,进入接口空间首頁,在这里默认选中独立接口,切换到産品接口或者项目接口,可以查看産品下的接口库和项目下的接口库。
2、查看庫和文檔
在首頁点击某个库、産品或项目,可以查看其下的文檔。
三、維護接口庫【15.7版本起】
1、創建接口庫
点击接口库--文檔页面右上角的创建按钮,即可进入接口库创建頁面。

创建接口库页面可以設置请求基路经,接口库的访问控制。
接口庫創建成功後,可以在左上角的接口庫下拉組件裏查看到。
创建接口库成功后,我们就可以对接口库进行目錄、版本管理、编辑和删除接口库操作。
2、维护接口库目錄
点击目錄右上角的更多图标的维护目錄,进入维护接口库的维护目錄。
按照使用需要添加接口库的目錄后,点击保存即可。
再次进入维护目錄页面,可以对目錄进行排序,编辑删除,添加子目錄的操作。
3、編輯和刪除接口庫
同样是点击目錄右上角的更多图标,点击下拉中的编辑接口库和删除接口库按钮进行操作。
編輯接口庫頁面:
刪除接口庫的確認頁面:
四、維護接口庫【18.4版本起】
1、創建接口庫
点击文檔--接口空間--创建库的按钮,可以创建接口库。
在創建庫的彈窗中,可設置请求基础路經、接口庫的訪問控制。支持創建獨立接口庫、産品接口库以及项目接口库。
选择私有权限后,可設置白名单用戶。
接口庫創建成功後,可以在左上角的接口庫下拉組件裏查看到。
创建接口库成功后,我们就可以对接口库进行目錄、版本管理、编辑和删除接口库操作。
2、查看某産品或某项目下的接口库或文檔
可选择産品或项目,查看其下的接口库和文檔。
3、维护接口库目錄
鼠标悬浮到某接口库上,点击右侧出现的更多按钮,可添加目錄、编辑库和删除库。
鼠标悬浮到某接口库下文檔时,点击右侧出现的更多按钮,可添加同级目錄、添加子目錄、编辑目錄和删除目錄。
编辑接口库:点击下拉菜单中的编辑接口库和编辑目錄按钮。
删除接口库:点击下拉菜单中的删除接口库和删除目錄按钮。
删除接口库和删除目錄会出现二次确认的弹窗
五、維護庫【21.1版本起】
1、創建庫
在接口空間首頁中,选择独立接口Tab項,点击创建库按钮,可以創建獨立接口库。选择産品接口/项目接口Tab項,点击创建库按钮,可以在産品或项目下创建接口库。
进入文檔列表页中,点击创建按钮,也可以在这里创建库。
在創建庫的彈窗中,可以选择接口库类型,在对应的産品/项目下创建创建库。
注:库的访问权限默认設置为公开,可以选择默认权限或私有权限,私有权限支持設置白名单用戶。

2、查看庫
在空间首頁,可以查看独立接口库及文檔的数量。当切换到産品接口/项目接口类型下后,可以查看所属项目集下的産品/项目。
进入库后,可以在左上角路径导航中切换三种类型,查看独立接口庫、産品接口库或项目接口库。
六、维护目錄【21.1版本起】
1、创建目錄
当库下没有目錄和文檔时,左侧目錄导航为空。可以点击添加目錄按钮,添加新目錄。
当库下已有文檔时,在底部設置按钮中,可以点击添加目錄按钮,添加新目錄。
当已有一个目錄时,在目錄的右侧更多按钮中,添加同级目錄或子目錄。
2、维护目錄
在目錄的右侧更多按钮中,可以编辑目錄或删除目錄。
编辑目錄时,可以更改所属库和上级目錄。
七、維護接口
维护好接口库的目錄后,我们就可以添加接口库文檔了。
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,导出格式仅支持导出为合并为一个文檔。
-
禅道産品
禅道開源版 禅道企業版 禅道旗艦版 禅道IPD版 -
核心功能
産品管理 項目管理 質量管理 效能管理 -
使用文檔
基本版手冊 企業版手冊 旗艦版手冊 IPD版手冊 開發中心手冊 -
幫助中心
积分問答 常見問題 論壇交流 使用視頻 Gitee GitHub -
關于我們
關于我們 禅道軟件 最新動態 禅道活動 -
禅道社區
禅道博客 積分排行 積分商城 禅道書院 -
聯系方式
聯系人:金娟 電話:18562856230 微信:18562856230 Q Q:1826606239北京、上海、深圳分部