spring boot配合swagger使用教程

Spring Boot 配合 Swagger 的教程通常涉及以下几个步骤：

1. **添加依赖**：
- 在你的`pom.xml`文件中添加Swagger和其UI的依赖。例如：

     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-boot-starter</artifactId>
         <version>3.x.y</version> <!-- 更新到最新的稳定版本 -->
     </dependency>
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>3.x.y</version>
     </dependency>

确保替换`x.y`为实际的版本号。

2. **配置Swagger**：
- 创建一个名为`application.yml`或`application.properties`的配置文件，并添加Swagger的配置信息，如API文档的标题、描述等。

   springfox:
     swagger-ui:
       path: /api-docs
     info:
       title: "My API Title"
       version: "1.0.0"

3. **扫描Controller并生成文档**：
- 在`@SpringBootApplication`上加上`@EnableSwagger2WebMvc`注解，启用Swagger支持。
- 如果你的控制器需要被扫描，可以使用`@RestController`和`@Api`注解。

4. **添加模型注解**：
- 对于请求和响应体，使用`@ApiModel`和`@ApiModelProperty`注解提供模型的描述。

5. **自动生成API文档**：
- 当应用启动时，Swagger会自动扫描你的RESTful API，并基于注解生成文档。访问`http://localhost:8080/swagger-ui.html`即可查看文档。

6. **测试和部署**：
- 检查文档是否正确显示，包括API列表、描述、参数和示例。然后你可以将这个URL集成到你的项目的帮助页面，或者通过其他方式提供给用户。