诸如 OpenAPI （以前称为 Swagger 规范）、RAML 和 API Blueprint 之类的 API 描述格式改变了团队对 API 文档的看法，提供了一种描述 API 行为和属性的新方法。近年来，OpenAPI (OAS) 获得了最广泛的采用，并且正在迅速成为 REST API 定义的行业标准。随着 OAS 的采用不断增加，新的工具不断涌现，以帮助释放定义 API 的强大功能。
使用 OAS 和 Swagger 构建出色的 API
Swagger 是使用 OAS 开发 API 时最广泛使用的工具生态系统。虽然 Swagger 的名称经常与规范互换使用，但现在 Swagger 代表了用于实现 OAS 的开源和专业工具的集合。Swagger UI 是最著名的用于使用 OAS 记录 API 的工具之一。通过使用 Swagger UI（无论是开源还是在 SwaggerHub 平台中），您可以将 OAS 合同转换为交互式 API 控制台，消费者可以使用该控制台与 API 交互，并快速了解 API 的行为方式。可视化所有内部 API，以便开发人员可以快速轻松地使用上游和下游服务。SwaggerUI 内置了交互性，因此外部消费者也可以尝试 API 的每个资源，并在将其用于代码库之前熟悉它。除了生成文档之外，Swagger 还支持使用 Swagger Codegen 为 API 生成实现代码和 SDK。它还可以帮助您从 SwaggerHub 平台内将 API 定义部署到 AWS、IBM API Connect、Apigee 和 Microsoft Azure 等常用的 API 网关。
开始使用 OAS 和 Swagger
虽然许多开发人员可以轻松地使用 OAS 从头开始设计全新的 API，但为现有 API 生成 OAS 却成为一个巨大的挑战。反向工程规范不仅需要大量工作，而且还需要一个学习曲线来熟悉从现有已开发 API 生成 OAS 的过程。Swagger 拥有多种工具来帮助完成此过程，包括用于从 Java API 创建 OAS 的流行的 Swagger Core 项目，以及我们新推出的名为 Swagger Inspector 的在线工具，该工具可以从任何 API 端点自动生成 OAS 定义。在我们最新的白皮书：为现有 API 编写文档：使用 OpenAPI 和 Swagger 轻松实现 API 文档中，我们介绍了 Swagger Inspector，并研究了开始使用 OAS 和 Swagger 的不同方法。我们涵盖了
- API 文档的重要性
- 使用 OpenAPI 规范 (OAS) 进行 API 文档
- 创建 OAS 的方法
- 使用 Swagger 工具为现有 API 生成 OAS
- 在 SwaggerHub 中记录您的 API
需要为现有的一组 API 生成 OpenAPI 定义？试用 Swagger Inspector。希望标准化您的设计和文档流程？立即开始使用 SwaggerHub。