import com.google.common.base.Predicate;
import com.google.common.base.Function;
import com.google.common.base.Optional;
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// .apis(RequestHandlerSelectors.basePackage("com.crcc.subaccess.service.controller"))
.apis(basePackage("com.crcc.subaccess.service.controller;com.crcc.subaccess.common.controller"))
//.apis(RequestHandlerSelectors.basePackage("com.crcc.subaccess.common.controller"))
.paths(PathSelectors.any())
.build().globalOperationParameters(this.getParameterList());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("后台服务系统")
.description("后台公共服务模块")
.contact("macro")
.version("1.0")
.build();
}
//添加header
private List<Parameter> getParameterList(){
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("Authorization").description("令牌").modelRef(new ModelRef("string"))
.parameterType("header").required(false).build();
pars.add(tokenPar.build());
return pars;
}
添加全局的header
.build().securitySchemes(security())
private List<ApiKey> security() {
return newArrayList(
new ApiKey("Authorization", "Authorization", "header"),
new ApiKey("Authorization1", "Authorization1", "header")
);
}
针对上方,去除不需要添加此header的请求接口
.build().securityContexts(securityContexts());
private List<SecurityContext> securityContexts() {
List<SecurityContext> securityContexts = new ArrayList<>();
securityContexts.add(SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("^(?!corgapi).*$")).build());
// .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
return securityContexts;
}
private List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
List<SecurityReference> securityReferences = new ArrayList<>();
securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
securityReferences.add(new SecurityReference("Authorization3", authorizationScopes));
return securityReferences;
}
//添加多个扫描包
public static Predicate<RequestHandler> basePackage(final String basePackage) {
return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
}
private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
return input -> {
// 循环判断匹配
for (String strPackage : basePackage.split(";")) {
boolean isMatch = input.getPackage().getName().startsWith(strPackage);
if (isMatch) {
return true;
}
}
return false;
};
}
private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
return Optional.fromNullable(input.declaringClass());
}
配置可信登录
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http.csrf().disable()
.authorizeRequests().anyRequest().permitAll();
// http.authorizeRequests()
// .anyRequest()
// .authenticated()
// .and()
// .oauth2Login()
// .authorizationEndpoint()
// .baseUri("/");// 指定登录路径
}
}
注解使用方式
不在swaggerui中显示
@ApiModelProperty(hidden = true)
备注必传
@ApiModelProperty(value = "每页显示多少条", required = true)
控制层
忽略参数,可以不传
@ApiIgnore
@Api(value = "接口",description = "接口",tags="审核管理")
方法参数注解
@ApiOperation("description")
@ApiImplicitParam(name = Constant.PAGE, value = "当前页码,从1开始", paramType = "query", required = true, dataType = "int"),
showdoc
https://blog.csdn.net/weixin_45651006/article/details/107315554
swagger导出文件
https://blog.csdn.net/weixin_42648692/article/details/105641976