为什么开发人员都不愿意写接口文档
为什么开发人员不愿写接口文档?是你没用对方法
大多数开发人员不愿意写接口文档的原因是:
写文档短期收益远低于付出的成本
,然而并不是所有人都能够坚持做有长期收益
的事情的。你因为写文档而耽误了当前项目进度,老板会直接找你麻烦;但是因为没写文档而带来的长期收益低,老板是看不见的。这就是现实,让人去做违反人性的事情是非常困难的。
作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试…”。
那能不能写好接口文档,大家都按文档来开发?很难,程序员最讨厌的两件事:1. 写文档,2. 别人不写文档。因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了,但文档还是旧的,各种同步不一致的情况,从而耽搁彼此的时间。
之前我们团队也遇到了同样的问题,那么作为研发团队的负责人,我是如何带领团队解决这个问题的呢?
如何做?
方法其实很简单,如果能做到让写文档 /维护文档这件事情的短期收益
就能远高于付出的成本
,那么所有问题都能迎刃而解,开发人员就会非常乐意去写接口文档。
团队原来的工作模式
- 使用 Swagger 写接口文档
- 前端开发 使用 RAP mock 接口数据
- 后端开发 使用 Postman 调试接口
- 测试人员 使用 JMeter 测试接口
我们遇到的问题
- 我们团队是前后端同步进入开发的,不能等后端开发完了才出接口文档,前端再进入开发,所以使用后端代码注释自动生成 Swagger 不适合我们。
- 写 Swagger 文档效率很低,并且有学习门槛,让团队所有人都熟练手写 Swagger 文档是不现实的,更何况团队不停有新人进来。
- 开发人员在 Swagger 定义好文档后,接口调试的时候还需要去 Postman 再定义一遍。
- 前端开发 Mock 数据的时候又要去 RAP 定义一遍,手动设置好 Mock 规则。
- 测试人员需要去 JMeter 定义一遍。
- 前端根据 RAP Mock 出来的数据开发完,后端根据 Swagger 定义的接口文档开发完,各自测试测试通过了,本以为可以马上上线,结果一对接发现各种问题:原来开发过程中接口变更,只修改了 Swagger,但是没有及时同步修改 RAP 。
- 同样,测试在 JMeter 写好的测试用例,真正运行的时候也会发现各种不一致。
- 开发过程,经常会有发现开始定义的接口文档有不合理的地方,需要临时调整,经常出现接口改了,但是文档没有更新。
- 时间久了,各种不一致会越来越严重。
如何解决
要做到写文档和及时维护文档的短期收益
就能远高于付出的成本
,无非两个方向:
- 降低写文档的成本
- 增加写文档后的收益
鉴于此,我们设想如果有一款工具做到以下这些是不是就非常爽了?
- 以
完全可视化
的界面来编写文档,并且是零学习成本,新人 一来就能上手。 - 可以通过接口文档定义的数据结构
自动 mock
出数据,而无需 前端开发 再写mock
规则。 - 后端开发 在接口文档基础上调试接口,而无需在去
Postman
上调试;接口如有变化,调试的时候就自动更新了文档,零成本的保障了接口维护的及时性。 - 后端开发 每次调试完一个功能就保存为一个
接口用例
。 - 测试人员 直接使用
接口用例
测试接口。 - 测试人员 更加接口文档自动生成测试用例,然后像
JMeter
一样在直接在上面测试。 - 根据接口文档定义的数据结构,自动生成前后端的
数据模型
代码。
总结下来,我们需要的就是这么一款工具:
通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock 、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
怎么办?自己干!
于是,我们自己实现了一个Postman + Swagger + RAP + JMeter
这个工具就是 Apifox
,经常很长一段时间不断更新迭代后,我们基本上完全实现了最初的设想,几乎完美解决了最开始遇到的所有问题,在公司内部大受欢迎。并且也形成了我们自己的最佳实践。
最佳实践
- 前端(或后端)在 Apifox 上定好
接口文档
初稿。 - 前后端 一起评审、完善
接口文档
,定好接口用例
。 - 前端 使用系统根据接口文档自动生成的
Mock 数据
进入开发。 - 后端 使用
接口用例
调试开发中接口,系统根据接口文档的定义自动校验
返回的数据是否正确,只要所有接口用例调试通过,接口就开发完成了。 - 后端 开发完成后,测试人员(也可以是后端)使用
集合测试
功能进行多接口集成测试,完整测试整个接口调用流程。 - 前后端 都开发完,前端从
Mock 数据
切换到正式数据
,联调通常都会非常顺利,因为前后端双方都完全遵守了接口定义的规范。
对外服务
没错,现在我们已经将Apifox
产品化对外服务了,你们团队也可以直接使用Apifox
了。
Apifox 主要功能
- 接口设计:Apifox 接口文档遵循 OpenApi3.0 (原 Swagger)、JSON Schema 规范的同时,提供了非常好用的
可视化
文档管理功能,零学习成本,非常高效。 - 数据模型:可复用的数据结构,定义接口
返回数据结构
及请求参数数据结构
(仅 JSON 和 XML 模式)时可直接引用。 - 接口调试:Postman 有的功能,比如环境变量、前置 /后置脚本、Cookie/Session 全局共享 等功能,Apifox 都有,并且和 Postman 一样高效好用。接口运行完之后点击
保存为用例
按钮,即可生成接口用例
,后续可直接运行接口用例,无需再输入参数,非常方便。 - 接口用例:通常一个接口会有多种情况用例,比如
参数正确
用例、参数错误
用例、数据为空
用例、不同数据状态
用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。 - 数据 Mock:内置 Mock.js 规则引擎,非常方便 mock 出各种数据,并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”,根据请求参数返回不同 mock 数据。最重要的是 Apifox
零配置
即可 Mock 出非常人性化的数据,具体在本文后面介绍。 - 接口自动化测试:提供接口集合测试,可以通过选择接口(或接口用例)快速创建测试集。目前接口自动化测试更多功能还在开发中,敬请期待!目标是:JMeter 有的功能基本都会有,并且要更好用。
- 快捷调试:类似 Postman 的接口调试方式,主要用途为临时调试一些
无需文档化
的接口,无需提前定义接口即可快速调试。 - 代码生成:根据接口及数据数据模型定义,系统自动生成
接口请求代码
、前端业务代码
及后端业务代码
。 - 团队协作:Apifox 天生就是为团队协作而生的,接口云端实时同步更新,成熟的
团队 /项目 /成员权限
管理,满足各类企业的需求。