我们为什么需要API管理系统?
随着web技术的发展,前后端分离成为越来越多互联网公司构建应用的方式。前后端分离的优势是一套Api可被多个客户端复用,分工和协作被细化,大大提高了编码效率,但同时也带来一些“副作用”:
- 接口文档不可靠。很多小伙伴管理接口文档,有使用wiki的,有word文档的,甚至还有用聊天软件口口相传的,后端接口对于前端就像一个黑盒子,经常遇到问题是接口因未知原因增加参数了,参数名变了,参数被删除了。
- 测试数据生成方案没有统一出口。我们都有这样的经历,前端开发功能依赖后端,解决方案有自己在代码注入json的,还有后端工程师临时搭建一套测试数据服务器,这种情况下势必会影响工作效率和代码质量,也不能及时进行更新。
- 资源分散,无法共享。接口调试每个开发者单独维护一套Postman接口集,每个人无法共用其他人的接口集,存在大量重复填写请求参数工作,最重要的是postman没法跟接口定义关联起来,导致后端没有动力去维护接口文档。
除了以上三点,对于我们公司的开发流程又会出现以下问题:
- 由于咱们公司的开发形式为多任务并行,前端与后端齐头并进各自开发,虽然原型只有一份,但是每个人的理解可能不止一种,这就导致当前后端都完成各自的前置后进行接口对接时出现字段不一致,多字段或少字段等问题,然后其中一方甚至双方对之前产出的代码进行更改,这里就会浪费大量的时间。
- 现在咱们项目的接口文档主要依靠word进行编写,一旦接口出了问题,更改文档的过程会十分繁琐耗时。
除了以上问题之外,我们可能还会遇到一些其他问题,比如文档的导出ÿ