Swagger
来自站长百科
Swagger 是一个开源的 API 设计和文档工具，它可以帮助开发人员更快、更简单地设计、构建、文档化和测试 RESTful API。Swagger 可以自动生成交互式 API 文档、客户端 SDK、服务器 stub 代码等，从而使开发人员更加容易地开发、测试和部署 API。
概述[ ]
Swagger主要用于帮助开发者设计、构建、文档化和测试RESTful API。Swagger起始于2011年，最初被称为“WireSpec”，后在2012年更名为“Swagger”。它迅速成为了开发和文档化API的流行选择。2015年，SmartBear软件公司收购了Swagger，随后推出了Swagger Toolchain，包括Swagger Editor、Swagger UI等一系列工具，以支持整个API生命周期的管理。
主要功能[ ]
- 设计和文档化 API：Swagger 提供了一种简单、易于使用的方式来设计和文档化 RESTful API。开发人员可以使用 Swagger UI 来创建和编辑 API 规范，然后使用 Swagger Editor 生成符合 OpenAPI 规范的 API 文档。Swagger UI 可以生成可交互的 API 文档，使开发人员更容易了解 API 的结构和用法。
- 自动生成代码：Swagger 可以自动从 OpenAPI 规范中生成客户端 SDK 和服务器 stub 代码。这些代码可以减少开发人员的工作量，加快代码开发速度。
- 测试 API：Swagger 提供了一个集成的测试工具，可以帮助开发人员测试 API 的功能、性能和可靠性。Swagger UI 中提供了一个测试页面，允许开发人员使用各种 HTTP 请求方法来测试 API 的不同端点。
- 集成和部署：Swagger 可以与许多流行的开发和部署工具（如 Git、Jenkins、Docker 等）集成，以便更容易地部署和管理 API。Swagger 可以自动生成 Swagger UI，使开发人员可以直接从浏览器访问 API 文档和测试页面。
环境介绍[ ]
- 操作系统：macOS Catalina 10.15.3
- IDEA：IntelliJ IDEA 2019.1 (Ultimate Edition)
- JDK：1.8
- SpringBoot：2.2.6RELEASE
- Swagger UI：2.9.2
- Swagger2：2.9.2
规范[ ]
Swagger Specification（Swagger 规范），规定了如何对 API 的信息进行正确描述。Swagger 规范，以前称作 Swagger Specification，现在称作 OpenAPI Specification（简称 OAS）。
Swagger 规范本身是与编程语言无关的，它支持两种语法风格：
在 Swagger 中，用于描述 API 信息的文档被称作 Swagger 文档。Swagger 的规范主要有两种：
- Swagger 2.0
- OpenAPI 3.0