import com.google.common.base.Predicates; import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping; import org.springframework.web.servlet.resource.PathResourceResolver; import org.springframework.web.servlet.resource.ResourceHttpRequestHandler; import org.springframework.web.util.UrlPathHelper; import springfox.documentation.annotations.ApiIgnore; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.*; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.service.contexts.SecurityContext; import springfox.documentation.spring.web.DocumentationCache; import springfox.documentation.spring.web.json.Json; import springfox.documentation.spring.web.json.JsonSerializer; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger.web.ApiResourceController; import springfox.documentation.swagger.web.SecurityConfiguration; import springfox.documentation.swagger.web.SwaggerResource; import springfox.documentation.swagger.web.UiConfiguration; import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper; import springfox.documentation.swagger2.web.Swagger2Controller; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import java.util.*; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket webApiConfig() { return new Docket(DocumentationType.SWAGGER_2) .groupName("webApi") .enable(true) .apiInfo(webApiInfo()) .select() .paths(Predicates.not(PathSelectors.regex("/api/stu/aclUserController/.*"))) .paths(Predicates.not(PathSelectors.regex("/error.*"))) .build(); } private ApiInfo webApiInfo() { return new ApiInfoBuilder() .title("网站-XXX系统API文档") .description("本文档描述了XXX微服务接口定义") .version("1.0") .contact(new Contact("XXX.", "http://www.XXX.com/", "XXX@163.com")) .build(); } private static final String DEFAULT_PATH = "/api/XXXXX"; /** * SwaggerUI资源访问 * * @param servletContext * @param order * @return * @throws Exception */ @Bean public SimpleUrlHandlerMapping swaggerUrlHandlerMapping(ServletContext servletContext, @Value("${swagger.mapping.order:10}") int order) throws Exception { SimpleUrlHandlerMapping urlHandlerMapping = new SimpleUrlHandlerMapping(); Map<String, ResourceHttpRequestHandler> urlMap = new HashMap<>(); { PathResourceResolver pathResourceResolver = new PathResourceResolver(); pathResourceResolver.setAllowedLocations(new ClassPathResource("META-INF/resources/webjars/")); pathResourceResolver.setUrlPathHelper(new UrlPathHelper()); ResourceHttpRequestHandler resourceHttpRequestHandler = new ResourceHttpRequestHandler(); resourceHttpRequestHandler.setLocations(Arrays.asList(new ClassPathResource("META-INF/resources/webjars/"))); resourceHttpRequestHandler.setResourceResolvers(Arrays.asList(pathResourceResolver)); resourceHttpRequestHandler.setServletContext(servletContext); resourceHttpRequestHandler.afterPropertiesSet(); //设置新的路径 urlMap.put(DEFAULT_PATH + "/webjars/**", resourceHttpRequestHandler); } { PathResourceResolver pathResourceResolver = new PathResourceResolver(); pathResourceResolver.setAllowedLocations(new ClassPathResource("META-INF/resources/")); pathResourceResolver.setUrlPathHelper(new UrlPathHelper()); ResourceHttpRequestHandler resourceHttpRequestHandler = new ResourceHttpRequestHandler(); resourceHttpRequestHandler.setLocations(Arrays.asList(new ClassPathResource("META-INF/resources/"))); resourceHttpRequestHandler.setResourceResolvers(Arrays.asList(pathResourceResolver)); resourceHttpRequestHandler.setServletContext(servletContext); resourceHttpRequestHandler.afterPropertiesSet(); //设置新的路径 urlMap.put(DEFAULT_PATH + "/**", resourceHttpRequestHandler); } urlHandlerMapping.setUrlMap(urlMap); //调整DispatcherServlet关于SimpleUrlHandlerMapping的排序 urlHandlerMapping.setOrder(order); return urlHandlerMapping; } /** * SwaggerUI接口访问 */ @Controller @ApiIgnore @RequestMapping(DEFAULT_PATH) public static class SwaggerResourceController implements InitializingBean { @Autowired private ApiResourceController apiResourceController; @Autowired private Environment environment; @Autowired private DocumentationCache documentationCache; @Autowired private ServiceModelToSwagger2Mapper mapper; @Autowired private JsonSerializer jsonSerializer; private Swagger2Controller swagger2Controller; @Override public void afterPropertiesSet() { swagger2Controller = new Swagger2Controller(environment, documentationCache, mapper, jsonSerializer); } /** * 首页 * * @return */ @RequestMapping("/swagger-resources/configuration/security") @ResponseBody public ResponseEntity<SecurityConfiguration> securityConfiguration() { return apiResourceController.securityConfiguration(); } @RequestMapping("/swagger-resources/configuration/ui") @ResponseBody public ResponseEntity<UiConfiguration> uiConfiguration() { return apiResourceController.uiConfiguration(); } @RequestMapping("/swagger-resources") @ResponseBody public ResponseEntity<List<SwaggerResource>> swaggerResources() { return apiResourceController.swaggerResources(); } @RequestMapping(value = "/v2/api-docs", method = RequestMethod.GET, produces = {"application/json", "application/hal+json"}) @ResponseBody public ResponseEntity<Json> getDocumentation( @RequestParam(value = "group", required = false) String swaggerGroup, HttpServletRequest servletRequest) { return swagger2Controller.getDocumentation(swaggerGroup, servletRequest); } } //以下为添加Token验证的代码 @Bean public Docket api() { // 单个方法添加请求参数,我们这里把token作为请求头部参数传入后端 // ParameterBuilder parameterBuilder = new ParameterBuilder(); // List<Parameter> parameters = new ArrayList<>(); // parameterBuilder.name("token").description("Token") // .modelRef(new ModelRef("string")).parameterType("header") // .required(false).build(); // parameters.add(parameterBuilder.build()); return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .securitySchemes(securitySchemes()) .securityContexts(securityContexts()); // .globalOperationParameters(parameters); } //以下为统一添加token验证信息的代码 private List<ApiKey> securitySchemes() { List<ApiKey> apiKeyList = new ArrayList<ApiKey>(); apiKeyList.add(new ApiKey("token", "token", "header")); return apiKeyList; } private List<SecurityContext> securityContexts() { List<SecurityContext> securityContexts = new ArrayList<>(); securityContexts.add( SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.regex("^(?!auth).*$")) .build()); return securityContexts; } 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("token", authorizationScopes)); return securityReferences; } }
统一验证Token的swagger配置类(直接CV即可)
于 2024-10-29 14:19:40 首次发布