为什么使用 Swagger 创建和记录 API

API 是连接软件工程师、共享宝贵数据和开发成果的最佳方式。通过 API，程序员可以访问一个由共享代码和实用经验组成的网络。然而，要访问这些内容，他们需要清晰的文档。

值得注意的是，早期不仅存在开发 API 的行业标准，而且也没有 API 文档的标准。Swagger作为一种构建 API 的方法应运而生，并很快成为最受欢迎的 API 框架。

两年前，Swagger 规范更名为 OpenAPI 规范并移至 Linux 基金会。

更重要的是，Swagger 框架得到了 Google、Microsoft、Atlassian 等公司的支持，Yelp、Netflix 等巨头也已经在工作中使用了它。

Swagger 是使用通用语言设计 API 的最大框架，支持整个 API 生命周期的开发，包括文档、设计、测试和部署。

该框架提供了一套工具，帮助程序员生成客户端或服务器代码并为Web服务安装自生成的文档。

然而，还有许多其他框架，例如 RAML、APIBlueprint、Summation 等。那么，如何解释 Swagger 的巨大流行呢？答案是，它提供了许多优势，除了创建清晰的文档外，还提供了其他很棒的功能。

首先，由于 Swagger 使用一种每个人都能理解的通用语言，因此开发人员和非开发人员都可以轻松理解。

因此，软件开发人员、产品和项目经理、业务分析师甚至潜在客户都可以访问 API 设计。

此外，由于 Swagger 易于调整，因此可以成功用于 API 测试和错误修复。另一个重点是，相同的文档可以用于加速各种依赖 API 的流程。

Swagger 提供了一套用于设计 API 和改进 Web 服务工作的优秀工具：

Swagger 编辑器– 支持编写 API 文档、设计和描述新 API 以及编辑现有 API。这是首个开源编辑器，能够以可视化方式呈现 OAS/Swagger 定义，并支持错误处理和实时反馈。

Swagger Codegen – 允许开发人员为不同平台生成客户端库代码。该工具通过生成服务器存根和客户端 SDK 来简化开发流程，从而使软件工程师能够更快地构建 API，并更好地专注于其应用。

Swagger UI – 允许工程师获取针对不同平台的自生成文档。Swagger UI 是一款完全可定制的工具，可托管在任何环境中。它的一大优势在于，它可以帮助开发人员节省大量编写 API 文档的时间。

Swagger Inspector – 一款用于测试和自动生成任何 API 的 OpenAPI 文档的工具。Swagger Inspector 让您能够轻松验证和测试 API，并且不受测试内容的限制。测试结果只需简单访问即可自动保存到云端。