API 是应用程序的外围组成部分，API 文档则具体记录如何应用应用程序，以及当应用程序呈现问题时，帮忙技术人员疾速定位问题。一份欠缺的 API 文档应思考到 API 的方方面面，甚至是 API 开发的交接工作。
团队内部人员流动时，对接工作是一个令人头疼的问题。在找到对接人之前，须要波及到多个部门，找到对接人后，还须要对对接人进行工作工作内容的交接。对于像 API 文档这种涉及面广且文档内容比拟细的文件，如果 API 文档自身存在缺点，则对接老本将大大提高。
应用 Office 工具记录 API
一些团队应用 Office 文档记录 API。尽管 Office 是弱小的文档工具，但排版是一个大问题，在应用 Office 记录 API 文档初期，就须要把文档排版做好。而 Office 的保护难度高，一旦须要交接，解说将变得艰难。若排版不适合或文档保护有问题，随着 API 的数量减少，保护的难度与老本更高。
应用 API 文档管理工具记录 API
应用 API 文档工具的益处在于文档可读性高、易保护、具体等。
目前市场有许多 API 文档工具，其中界面清晰、功能完善的工具有 Postman、Swagger、Eolinker。Postman 可记录 API，测试性能也弱小，但偏差测试，文档方面没有比 Swagger、Eolinker 杰出。Swagger 文档应该都不生疏，界面配色难看。Eolinker 则适宜各种规模的企业，本文应用 Eolinker 进行演示。
API 工具在展现 API 时，不仅可蕴含 API 的根底信息，如申请参数、url 等，还可查看 API 的状态、示例。Eolinker 还能够查看变更历史与比照变更历史。
应用 API 管理工具进行对接，只须要领导对接人如何查看 API 文档，应界面都是可视化操作，所以在应用上与保护上也比较简单。
如果有打算让 API 文档放弃简略且易对接的团队，能够尝试应用 API 管理工具进行 API 治理，它们不仅仅是文档工具，其中还蕴含弱小的测试性能。
演示工具应用地址：www.eolinker.com