SpringBoot integrates swagger 3.X
1. Introduce dependencies
<!--引入spring web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入swagger3 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2. swagger configuration
package com.javaboy.vhr.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.ResponseBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Response;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.ArrayList;
import java.util.List;
/**
* @Author: gaoyang
* @Date: 2020/12/23 10:46
* @Description: swagger3.0 配置
*/
@Configuration
@EnableOpenApi
public class Swagger3Config {
/**
* swagger3的配置文件
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.apis(RequestHandlerSelectors.basePackage("com.javaboy.vhr.controller"))
.paths(PathSelectors.any())
.build()
//.globalRequestParameters(getGlobalRequestParameters())
.globalResponses(HttpMethod.GET, getGlobalResponseMessage())
.globalResponses(HttpMethod.POST, getGlobalResponseMessage())
.globalResponses(HttpMethod.DELETE, getGlobalResponseMessage())
.globalResponses(HttpMethod.PUT, getGlobalResponseMessage());
}
/**
* 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
*/
private ApiInfo apiInfo() {
// 获取工程名称
String projectName = System.getProperty("user.dir");
return new ApiInfoBuilder()
.title(projectName.substring(projectName.lastIndexOf("\\") + 1) + " API接口文档")
.contact(new Contact("Mr.Gao", "https://blog.csdn.net/weixin_42201180", "[email protected]"))
.version("1.0")
.description("API文档")
.build();
}
/**
* 生成全局通用参数
*
* @return
*/
/*private List<RequestParameter> getGlobalRequestParameters() {
List<RequestParameter> parameters = new ArrayList<>();
parameters.add(new RequestParameterBuilder()
.name("x-access-token")
.description("令牌")
.required(false)
.in(ParameterType.HEADER)
.build());
parameters.add(new RequestParameterBuilder()
.name("Equipment-Type")
.description("产品类型")
.required(false)
.in(ParameterType.HEADER)
.build());
return parameters;
}*/
/**
* 生成通用响应信息
*
* @return
*/
private List<Response> getGlobalResponseMessage() {
List<Response> responseList = new ArrayList<>();
responseList.add(new ResponseBuilder().code("404").description("找不到资源").build());
return responseList;
}
}
3. Start program access
Visit after startup: http://127.0.0.1:8090/swagger-ui/index.html
4. Integrated enhanced document knife4j
4.1 Add dependency
<!--Knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
4.2 Add @EnableKnife4j annotation to swagger configuration class
4.3 Start access
Start access to the api document: http://127.0.0.1:8090/doc.html
5. Close swagger in the build environment
# swagger3.0 settings
springfox:
documentation:
swagger-ui:
enabled: true # true放开api文档,false关闭api文档
6. Integrate Spring Security
If Spring Security integrates swagger to release swaggerAPI
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/swagger-ui/index.html",
"/swagger-ui/**",
"/doc.html",
"/webjars/**",
// swagger api json
"/v3/api-docs",
//用来获取支持的动作
"/swagger-resources/configuration/ui",
//用来获取api-docs的URI
"/swagger-resources",
//安全选项
"/swagger-resources/configuration/security",
"/swagger-resources/**");
}