开发人员使用API定义软件和服务之间的交互，但是一个项目不仅仅只创建一个API，而API文档影响API的使用。企业在给定的服务创建一个API，以便团队内部人员，业务合作伙伴甚至公共的开发人员可以将其各自的软件与该服务集成，例如百度地图，在位置服务方面发挥着重要的作用。
API本身并不是需要所有用户从服务中获取价值。在API中规定着可用的API调用或请求、语法、规则、数据格式和其他信息。好的文档几乎和API的底层代码一样重要。没有良好的API文档可能会导致用户花大量时间学习如何使用并且容易出差错，这会减慢连接到API服务的应用程序的开发和性能。
API文档的基本信息
文档是有关API的主要信息源。其中包括：
API可用的特性和功能；
全面的功能和语法参考；
教程、示例。
获取支持或其他信息。
API文档有三大类：参考、示例和教程。
参考文档涵盖了API的详细信息。它详细说明了API支持的每个调用或请求的目的，功能和完整语法。
示例文档使用参考文档中的详细说明提供API用例的众多示例。
教程文档着重于为API提供上下文。API文档通常包括一系列基于示例的指南和教程，用来提供有关API使用的全面讨论。教程和指南通常显示了多个API调用和请求如何在实际代码段的上下文中一起工作，以完成除单个调用之外的任务。
API文档工具
由上可知，API文档难以生成和维护。几乎所有的文档都是这样，但是编写API文档特别具有挑战性，因为涉及到无数的技术细节。一些小的文档错误，都可能会使API调用失败。API数量是另一个问题。一个团队的每一个附加的API都会产生更多的API文档来维护，再加上软件开发周期的不断缩短，使得开发人员几乎没有时间创建和维护高质量的API文档。
有许多商业和开源工具可用于自动化和组织API文档（确保一致的样式和内容）。大多数自动化的API管理工具都使用OpenAPI规范。该规范概述了描述、产生、使用和可视化RESTful Web API的标准化格式。该标准化规范有助于开发团队快速生成一致的文档，并避免因手动文档尝试而引起的错误。
翻译：Eolinker
演示工具：www.eolinker.com