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