什么是 Swagger

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

您的 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 集成的开源和商业工具。