适用前提与职责划分
本文设计禅道需求、YApi 接口契约、GitLab 变更与 Confluence 或语雀交接的协作流程,验证等级为 PENDING。各平台可以先通过受控链接人工关联,不假设已经安装插件、开通 API 或完成双向同步。禅道保存需求与验收责任,YApi 描述接口,GitLab 留存实现和评审,知识载体保存运行说明;同一字段必须明确唯一维护方。
需求基线与变更编号
由业务负责人确认范围、非目标、影响用户、验收条件和期望窗口,记录需求编号及修订时间。将接口任务、测试用例和代码评审链接挂到该编号,接口更改需要更新需求影响分析。不要把“任务已完成”直接等同于“功能已发布”;待测试、待发布和已验收应能区分,实际状态名称按所用禅道版本配置。禅道测试申请说明
契约先行与敏感数据
YApi 契约写明方法、路径、鉴权方式、请求字段、响应字段、错误码、分页以及兼容期。Mock 只用于模拟约定数据,不能证明后端鉴权、数据一致性或性能达标。示例使用虚构身份,禁止导入带真实 Cookie、Authorization 或个人数据的 HAR。导入前审阅差异,避免全量覆盖他人修订;接口测试只指向批准的隔离环境。YApi 官方项目说明
代码评审与证据关联
GitLab 合并请求写入需求编号、接口契约链接、测试记录及不兼容变更说明。固定提交 SHA 和契约修订,不依靠随时变化的分支名;接口差异由开发和测试共同确认。跨平台自动化如需新增,只授予必要范围并设置幂等标识、错误队列和人工补偿入口;本流程不会因为缺少同步插件而跳过审批。
验收分支与发布状态
按正常输入、缺失字段、错误身份、边界参数和旧客户端分别验收。Mock 通过但真实请求失败时转查实现、配置、网络与依赖;实现正常但文档不符时冻结受影响发布并修订契约,不能悄悄把期望响应改成错误结果。需求范围发生变化则退回业务评审,而不是扩大本次上线范围。
文档交接与访问校验
Confluence 和语雀是可选的知识载体,应选定主文档避免默认双写。交接包包含发布日期、需求编号、提交、制品摘要、配置键说明、监控入口、告警负责人、恢复步骤和遗留风险,凭据只指向受控保管位置。若选 Confluence,明确 Cloud、Data Center 与内容类型;页面版本和权限行为不能不加区分地套用到所有形态。用真实接班人的权限验证链接和附件可读,匿名及无关组不可访问。Confluence 页面与版本说明
停止、纠错与验收完成
缺少接班人、错误码未定义、敏感示例泄露或链接无法访问时停止交接完成状态。文档回到前一修订不等于代码或接口回退;保留旧契约并注明适用版本,另走发布恢复流程。交接完成应由接班人复述入口、演练一次只读诊断,并签收风险与观察期限。配套见跨平台变更交接场景及WIKI 运行手册。