注意:swagger2 需要 jdk1.8以上才可运行
2. 编写swaggerConfig配置类io.springfox springfox-swagger2 2.8.0 io.springfox springfox-swagger-ui 2.8.0
package cc.test.zdq.common.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.ApiKey; import springfox.documentation.service.AuthorizationScope; import springfox.documentation.service.SecurityReference; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.service.contexts.SecurityContext; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.Arrays; import java.util.List; @EnableSwagger2 @Configuration public class SwaggerConfig { private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot 集成 Swagger2 构建RESTful API") .description("wx") .version("2.8.0") .description("test API") .build(); } @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(true) .select() //导入依赖的package包/类 .apis(RequestHandlerSelectors.basePackage("cc.test.zdq")) .paths(PathSelectors.any()) .build() //配置token令牌验证 .securitySchemes(securitySchemes()) .securityContexts(securityContexts()); //.globalOperationParameters(pars); } private List启动项目后在浏览器输入:http://ip:port/swagger-ui.htmlsecurityContexts() { return Arrays.asList(SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.any()) .build()); } private List securitySchemes() { //Authentication: 需要换成自己的身份验证标头 return Arrays.asList(new ApiKey("Authentication", "Authentication", "header")); } List defaultAuth() { AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything"); AuthorizationScope[] authorizationScopes = new AuthorizationScope[1]; authorizationScopes[0] = authorizationScope; return Arrays.asList(new SecurityReference("Authentication", authorizationScopes)); } }
如图:
至此 swagger2 的配置就完成了