这才叫 API 接口设计!
一家公司的每个系统都会有各种各样的接口,但是大部分公司,特别是传统行业的公司的所谓接口文档更多是当每个系传统的 word 文本格式,这种传统的格式有着人尽皆知的痛点:
1. 维护不及时;
2. 与代码不同步;
3. 归档后“便束之高阁”;
4. 接口文档跟代码没有互动;
5. 文本检索无法建立全局搜索,需要额外借助工具。
为了解决上述的问题,需要建立一套行之有效的接口管理体系,该体系的目标是:
1. 能够进行接口文档管理,作为后续的接口治理的其中一部分;
2. 能作为接口测试的平台,这样能保证接口跟代码是同步的;
3. 支持文本检索。