项目开发效率怎么提高——围绕API接口文档

通过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 的编辑历史,对比当前版本和历史的某个版本的差别。或者是回滚到历史上的任何一次编辑,查看历史版本的详细内容。

你可能感兴趣的