通过 API 文档驱动开发流程
最近和同行交换时也听到一个观点:采纳“文档驱动”的合作模式,比“先开发、后保护文档”和“口头沟通确认”的形式,团队合作效率和产品质量都能失去进步。
因而在理解后,最近项目组找了个工具,尝试基于文档来进行工作,应用有章可循的“文档驱动”形式来升高大量无意义的沟通老本。
应用 Eolinker 进行开发协同工作
在 Eolinker 中,咱们简直所有的合作工作都是围绕着 API 接口文档进行的。创立了 API 文档之后,所有人都能够随时查看 API 的改变状况,依据 API 文档发动 API 测试,编写 API 测试用例,创立 Mock API,进行 API 自动化测试等。
应用地址:www.eolinker.com
为 API 设置适合的状态为 API 设置适合的状态
Eolinker 将 API 的状态划分为以下几种,不便成员在查看 API 文档时理解 API 以后所处的状态。
已公布:API 已公布,可失常应用
设计中:期待或正在设计 API
待确定:API 已设计实现,期待相干成员确定 API 的内容
开发:API 已确定内容,期待或正在开发
对接:API 已开发实现,期待或正在对接
测试:API 已对接实现,期待或正在测试
实现:API 已测试实现,期待公布
异样:API 出现异常,须要尽快排查
保护:API 保护或降级中
废除:API 已废除,不可失常应用
为 API 设置变更告诉为 API 设置变更告诉
能够通过变更告诉性能,设置当 API 状态或者内容扭转时主动通过站内信或者邮件等形式告诉相干的成员。
对 API 发表评论对 API 发表评论
你能够通过 API 评论性能,间接在 API 文档上公布评论,所有的沟通内容都会追随 API 文档保留下来并且依照版本分类好,而不是零散地存在各种聊天工具中。
理解和比照 API 的变更历史理解和比照 API 的变更历史
如果想理解 API 以后版本更新的内容,能够间接查看 API 的编辑历史,比照以后版本和历史的某个版本的差异。或者是回滚到历史上的任何一次编辑,查看历史版本的具体内容。