敏捷开发专题：进行接口管理必须注意的4点问题

敏捷开发专题：进行接口管理必须注意的敏捷开发专题：进行接口管理必须注意的4 点问题点问题 敏捷开发以用户的需求进化为核心，采用迭代、循序渐进的方法进行软件开发，为了保证开发迭代的速度与稳定性，整个项目需要有一个足够灵活的文档系统来支撑代码以及接口等设计工作，今天我们针对接口管理的需求来列举工作中需要注意的几点问题。 / 1 / 切勿开发完成之后再补全文档 许多开发者为了贪图方便，想着开发完成之后再去阅读代码补全文档。但是实际的情况是，敏捷开发的短周期特点导致了开发者往往没有足够的空闲时间等到“代码开发完成”，因为每一个阶段的开发结束都意味着下一开发周期的开始，一旦一开始没有建立起编写文档的习惯，往往等到项目最终完成之后，代码量已经庞大到需要花费非常多的额外精力去补全文档，这在许多开发者看来是一件不可接受的“麻烦事”。 一个好的接口文档不仅可以帮助后端开发人员复核工作的内容，检查开发问题，还可以方便前端开发人员进行对接，减少后期联调阶段的时间耗费。因此开发人员和管理人员都应该建立起接口管理的意识。 / 2 / 文档应该事先规范格式 编写文档并非用文本文件去简单编写即可，文档不仅是开发人员自己的工具，也是合作开发者进行协作的有利工具，格式、文风统一的接口文档不仅有助于提高阅读的体验，还可以极大的促进对接的效率。就像一本书，如果每一章节的格式文风都不一样，阅读起来也是一件非常扫兴的事情。 eolinker AMS 接口管理平台提供了一致的接口文档格式，不仅可以方便开发人员进行接口录入，还可以让协作开发人员在对接的时候可以高效协作。 / 3 / 接口文档应该注明版本更新内容 每一个文档都应该是可以被溯源的，至少包含什么人在什么时候做了什么改动等信息。 敏捷开发的短周期特点也使得产品需求无法在一开始就考虑全面，因此由需求改动带来的代码、文档改动是很频繁的。这时候文档应该定期保存历史版本，或者附上更新更新的内容，方便后期查阅修改的历史。 eolinker AMS 接口管理平台提供了针对接口文档的版本管理功能，可以非常清晰地记录下开发人员在何时对接口作出的任何改动，目前支持最多 10 次的修改历史回滚，就像是接口管理领域的 Github。 / 4 / 文档内容应该是可测试的 文档内容不应该是简单的堆积，后台开发人员还应该提供可以真是被前端开发人员测试的接口参数示例以及返回示例等。 如果接口的信息比较复杂，那么 eolinker AMS 的接口测试以及 mock 就可以帮上忙了，它提供了目前业内最详细的接口文档的记录项，并且还可以根据请求参数自动生成测试的数据等，一键得到返回结果，非常方便。