跳到内容

什么是 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 集成的开源商业工具
© . All rights reserved.