OAS 2 此页面适用于 OpenAPI 规范 2.0 版（以前称为 Swagger）。
要了解最新版本，请访问 OpenAPI 3 页面。

什么是 Swagger？

Swagger 允许您描述 API 的结构，以便机器可以读取它们。API 描述自身结构的能力是 Swagger 所有强大功能的根源。为什么它如此强大？好吧，通过读取 API 的结构，我们可以自动构建美观且交互式的 API 文档。我们还可以自动为您的 API 生成多种语言的客户端库，并探索其他可能性，例如自动化测试。Swagger 通过要求您的 API 返回包含整个 API 的详细描述的 YAML 或 JSON 来做到这一点。此文件本质上是您的 API 的资源列表，它符合 OpenAPI 规范。规范要求您包含以下信息：

• 您的 API 支持哪些操作？
• 您的 API 的参数是什么，它返回什么？
• 您的 API 是否需要授权？
• 以及一些有趣的内容，例如使用 API 的条款、联系信息和许可。

您可以手动编写 API 的 Swagger 规范，也可以从源代码中的注释自动生成它。请查看 swagger.io/open-source-integrations，了解可以从代码生成 Swagger 的工具列表。

那么，我已经为我的 API 创建了 Swagger 规范。接下来呢？

Swagger 可以帮助您进一步推动 API 开发的方式有很多种

• 设计优先用户：使用 Swagger Codegen 为您的 API **生成服务器存根**。剩下的就是实现服务器逻辑 - 您的 API 就可以上线了！
• 使用 Swagger Codegen 为您的 API **生成 40 多种语言的客户端库**。
• 使用 Swagger UI 生成 **交互式 API 文档**，让您的用户可以直接在浏览器中尝试 API 调用。
• 使用规范将 API 相关工具连接到您的 API。例如，将规范导入 SoapUI，为您的 API 创建自动化测试。
• 还有更多！查看与 Swagger 集成的 开源 和 商业工具。