使用 Swagger-Spring-Boot-Starter 进行集成
时间: 2024-01-11 10:03:04 浏览: 125
Swagger-Spring-Boot-Starter 是一个用于集成 Swagger 和 Spring Boot 的开源项目,它提供了一套简单易用的 API 文档生成工具,可以帮助开发者快速地生成 API 文档。
要使用 Swagger-Spring-Boot-Starter 进行集成,需要按照以下步骤进行操作:
1. 在 Maven 中添加 Swagger-Spring-Boot-Starter 依赖
在 Maven 的 pom.xml 文件中添加以下依赖:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 添加 Swagger 配置类
在 Spring Boot 项目中添加一个 Swagger 配置类,用于配置 Swagger 相关的参数。
```
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
3. 启动应用程序
在 Spring Boot 项目启动之后,访问 `http://localhost:8080/swagger-ui.html` 就可以看到生成的 API 文档了。
以上就是使用 Swagger-Spring-Boot-Starter 进行集成的简单步骤。当然,Swagger-Spring-Boot-Starter 还提供了更多的配置选项,可以根据具体需求进行配置。
阅读全文