API 文档是成功使用和集成 API 所需的信息。它可以是技术写作、代码示例和示例的形式，以便更好地理解如何使用 API。对于希望推动 API 采用的组织而言，简洁明了的文档（使您的 API 用户能够快速将其集成到他们的应用程序中）不再是可选的。
Swagger 如何帮助 API 文档
Swagger 定义了 API 的 RESTful 契约，使 API 的所有利益相关者，无论是您的开发团队还是您的最终用户，都能理解 API 的作用并与其各种资源进行交互，而无需将其集成到他们自己的应用程序中。Swagger 有助于为 API 定义一种与语言无关的、人类可读的格式，从而简化实现、推动采用并稳定开发。自创建以来，Swagger 已成为世界上最流行的 API 开发框架，每月开源 Swagger 工具的下载量超过一百万次，并且已发展成为设计和记录 RESTful API 的行业标准。
将 Swagger 添加到您的 API
开发团队采用多种方法将 Swagger 添加到他们的 API 中。由于 Swagger 受到庞大的开发者社区的支持，这些方法中的每一种也受到许多开源和商业工具的支持。在此免费电子书下载中，我们研究了两种最常用的方法：运行时 Swagger 生成和构建时 Swagger 生成，并介绍了可用于支持这些方法的一些工具。您可以通过单击下面的链接将电子书下载为 PDF。下载：使用 Swagger 记录现有 API 您也可以通过翻阅页面底部的 SlideShare 演示文稿来阅读电子书。
想要更多此类资源吗？
我们每月会发送几次包含我们最新 API 资源的电子邮件。使用右侧的注册表格加入！