springboot 整合swagger2
时间: 2023-04-24 11:01:39 浏览: 183
SpringBoot整合Swagger2.docx
Spring Boot可以很方便地集成Swagger2,只需要添加相应的依赖和配置即可。
1. 添加Swagger2依赖
在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. 配置Swagger2
在Spring Boot的启动类中添加Swagger2的配置:
```
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot集成Swagger2")
.description("Spring Boot集成Swagger2的示例项目")
.version("1.")
.build();
}
}
```
其中,`createRestApi()`方法用于创建Docket对象,`apiInfo()`方法用于设置Swagger2文档的基本信息,`RequestHandlerSelectors.basePackage()`用于指定扫描的包路径,`PathSelectors.any()`用于指定扫描的路径。
3. 测试Swagger2
启动Spring Boot应用程序后,在浏览器中访问`http://localhost:808/swagger-ui.html`,即可看到Swagger2的UI界面,可以在此界面中查看API文档、测试API等。
阅读全文