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