swagger2使用github开源xiaoymin-ui
1、导入依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><g
1、导入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>1.5.22</version> <!-- <scope>compile</scope>--> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>1.5.20</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.8.9</version> </dependency>
2、配置 SwaggerConfig 类
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI; import io.swagger.annotations.ApiOperation; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ParameterBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.*; 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; @Configuration //必须存在 @EnableSwagger2 //必须存在 @EnableSwaggerBootstrapUI @Profile({"dev","test","pre"}) //生产环境不开放SwaggerUI接口 public class SwaggerConfig implements WebMvcConfigurer { /** * * * swaggerUI接口访问地址 : http://localhost:9999/doc.html * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/"); } /** * 业务管理分组 * @return */ @Bean public Docket customDocket(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("业务管理") .select() .apis(RequestHandlerSelectors.basePackage("com.my.app.biz")) //加了ApiOperation注解的类,才生成接口文档 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build(); //.securitySchemes(Collections.singletonList(securityScheme())); } /** * 系统管理分组 * @return Docket */ @Bean public Docket createSysRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()).groupName("系统管理") .select() //此包路径下的类,才生成接口文档 .apis(RequestHandlerSelectors.basePackage("com.my.admin.modules")) //加了ApiOperation注解的类,才生成接口文档 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build(); //.securitySchemes(Collections.singletonList(securityScheme())); } /** * name:开发者姓名 * url:开发者网址 * email:开发者邮箱 * @return */ private ApiInfo apiInfo() { Contact contact = new Contact("赖全强", "https://github.com/laiqq", "375113044@qq.com"); return new ApiInfoBuilder() .title("DiLink_ADMIN API接口")//标题 .description("API接口的描述")//文档接口的描述 .contact(contact) .version("1.1.0")//版本号 .build(); } /* 接口统一token设置, 在head传 X-Access-Token */ @Bean SecurityScheme securityScheme() { return new ApiKey("X-Access-Token", "X-Access-Token", "header"); } private List<Parameter> setHeaderToken() { ParameterBuilder tokenPar = new ParameterBuilder(); List<Parameter> pars = new ArrayList<>(); tokenPar.name("X-Access-Token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build(); pars.add(tokenPar.build()); return pars; } }
3、controller类url加入注解
4、请求参数加入注解
5、响应参数加入注解
6、放行一些url配置
import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.stereotype.Component; import java.util.List; /** * <p> MyProperties </p> * */ @Data @ConfigurationProperties(prefix = "myconfig", ignoreUnknownFields = false) @Component @RefreshScope public class MyProperties { /** * SWAGGER参数 */ private final Swagger swagger = new Swagger(); /** * 安全认证 */ private final Auth auth = new Auth(); /** * SWAGGER接口文档参数 */ @Data public static class Swagger { private String title; private String description; private String version; private String termsOfServiceUrl; private String contactName; private String contactUrl; private String contactEmail; private String license; private String licenseUrl; } @Data public static class Auth { /** * token过期时间(分钟) */ private Integer tokenExpireTime; /** * 用户选择保存登录状态对应token过期时间(天) */ private Integer saveLoginTime; /** * 限制用户登陆错误次数(次) */ private Integer loginTimeLimit; /** * 错误超过次数后多少分钟后才能继续登录(分钟) */ private Integer loginAfterTime; /** * 忽略安全认证的URL */ private List<String> ignoreUrls; } }
7、配置文件放行url内容:
myconfig:
#安全认证
auth:
# token过期时间(分钟)
tokenExpireTime: 60
# 用户选择保存登录状态对应token过期时间(天)
saveLoginTime: 7
# 限制用户登陆错误次数(次)
loginTimeLimit: 10
# 错误超过次数后多少分钟后才能继续登录(分钟)
loginAfterTime: 10
ignoreUrls:
- /login
- /api/system/user/getCurrentUserInfo
- /index
- /logout
- /swagger-ui.html
- /swagger-resources/**
- /swagger-resources/configuration/ui
- /swagger-resources
- /v2/api-docs
- /swagger-resources/configuration/security
- /swagger/**
- /**/v2/api-docs
- /**/*.js
- /**/*.css
- /**/*.png
- /**/*.ico
- /actuator/health
- /actuator/info
更多推荐
所有评论(0)