一：配置攔截器
默認攔截器是對Swagger2請求時攔截的。
@Configuration @EnableWebMvc public class MvcConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { //配置登錄攔截器 registry.addInterceptor(new AuthorizedCheckInterceptor()). addPathPatterns("/**") .excludePathPatterns("/users/login/**", "/swagger-resources/**", "/webjars/**", "/swagger-ui.html/**"); } @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { //將templates目錄下的CSS、JS文件映射為靜態資源，防止Spring把這些資源識別成thymeleaf模版 // registry.addResourceHandler("/templates/**.js").addResourceLocations("classpath:/templates/"); //registry.addResourceHandler("/templates/**.css").addResourceLocations("classpath:/templates/"); //其他靜態資源 //registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/"); //swagger增加url映射 registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } }
二 配置全局參數
如配置所有請求header中需要添加token，配置全局響應碼
package org.niugang.coding.conf; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.bind.annotation.RequestMethod; import springfox.documentation.builders.*; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.service.Parameter; import springfox.documentation.service.ResponseMessage; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; import java.util.List; /** * 接口文檔 * * @author Created by niugang on 2018/12/28/15:10 */ @Configuration @EnableSwagger2 public class SwaggerConfig { /** * 全局參數(如header中的token) * * @return List<Parameter> */ private List<Parameter> parameter() { List<Parameter> params = new ArrayList<>(); params.add(new ParameterBuilder().name("token") .description("請求令牌") .modelRef(new ModelRef("string")) .parameterType("header") .required(false).build()); return params; } @Bean public Docket sysApi() { //設置全局響應狀態碼 List<ResponseMessage> responseMessageList = new ArrayList<>(); responseMessageList.add(new ResponseMessageBuilder().code(404).message("找不到資源").responseModel(new ModelRef("ApiError")).build()); responseMessageList.add(new ResponseMessageBuilder().code(400).message("參數錯誤").responseModel(new ModelRef("ApiError")).build()); responseMessageList.add(new ResponseMessageBuilder().code(401).message("沒有認證").responseModel(new ModelRef("ApiError")).build()); responseMessageList.add(new ResponseMessageBuilder().code(500).message("服務器內部錯誤").responseModel(new ModelRef("ApiError")).build()); responseMessageList.add(new ResponseMessageBuilder().code(403).message("沒有沒有訪問權限").responseModel(new ModelRef("ApiError")).build()); responseMessageList.add(new ResponseMessageBuilder().code(200).message("請求成功").responseModel(new ModelRef("ApiError")).build()); return new Docket(DocumentationType.SWAGGER_2) .globalResponseMessage(RequestMethod.GET, responseMessageList) .globalResponseMessage(RequestMethod.POST, responseMessageList) .globalResponseMessage(RequestMethod.PUT, responseMessageList) .globalResponseMessage(RequestMethod.DELETE, responseMessageList) .apiInfo(apiInfo()) .select() //默認顯示所有controller .apis(RequestHandlerSelectors.basePackage("org.niugang.coding")) .paths(PathSelectors.any()) .build().globalOperationParameters(parameter()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("new-coding-standards-user") .description("springboot新代碼規范腳手架工程") .termsOfServiceUrl("") .contact(new Contact("niugang", "", "863263957@qq.com")) .version("1.0") .build(); } } 微信公眾號
JAVA程序猿成長之路
分享資源，記錄程序猿成長點滴。專注於Java,Spring,SpringBoot,SpringCloud，分布式，微服務。