springboot整合swagger2
时间: 2023-05-01 14:01:22 浏览: 104
Spring Boot 集成 Swagger 2 的方法有多种,常用的有以下几种:
1.使用 Springfox Swagger2 插件进行集成。
2.使用 Swagger-Spring-Boot-Starter 进行集成。
3.手动配置 Swagger2 信息。
这三种方式的具体实现方法可以在 Spring Boot 官网和 Swagger 官网上查看。
相关问题
springboot 整合swagger2
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等。
springboot 整合swagger 2
在Spring Boot项目中整合Swagger 2,需要添加相关的Maven依赖。可以引用三个依赖,分别是springfox-swagger2、springfox-swagger-ui和swagger-bootstrap-ui。这些依赖会添加Swagger 2以及Swagger UI的支持。在Spring Security中进行配置时,如果希望Swagger 2文档不被拦截,可以在Spring Security的配置类中重写configure方法,并添加对应的过滤规则,例如忽略"/swagger-ui.html"、"/v2/"和"/swagger-resources/"。这样配置后,就可以在项目中使用Swagger 2了。
阅读全文