yshop1.7.2发布:新增小程序支付与登录,后台新增小程序跳转页面,升级swagger-bootstrap,swaager统一配置迁移到common(防止注解冲突)

2020-01-09 16:09:50 +08:00
parent ebaee90bd9
commit 5c88f8281f
15 changed files with 224 additions and 118 deletions
--- a/yshop-common/src/main/java/co/yixiang/config/SwaggerConfig.java
+++ b/yshop-common/src/main/java/co/yixiang/config/SwaggerConfig.java
@ -0,0 +1,126 @@
+package co.yixiang.config;
+
+import com.fasterxml.classmate.TypeResolver;
+import com.google.common.base.Predicates;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.data.domain.Pageable;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.ParameterBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.schema.AlternateTypeRule;
+import springfox.documentation.schema.AlternateTypeRuleConvention;
+import springfox.documentation.schema.ModelRef;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Parameter;
+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;
+import static com.google.common.collect.Lists.newArrayList;
+import static springfox.documentation.schema.AlternateTypeRules.newRule;
+
+
+/**
+ * api页面 /doc.html
+ * @Author hupeng <610796224@qq.com>
+ * @Date 2019/1/9
+ **/
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+
+    @Value("${jwt.header}")
+    private String tokenHeader;
+
+    @Value("${jwt.token-start-with}")
+    private String tokenStartWith;
+
+    @Value("${swagger.enabled}")
+    private Boolean enabled;
+
+    @Value("${swagger.title}")
+    private String title;
+
+    @Value("${swagger.version}")
+    private String version;
+
+    @Value("${swagger.serverUrl}")
+    private String serverUrl;
+
+    @Bean
+    @SuppressWarnings("all")
+    public Docket createRestApi() {
+        ParameterBuilder ticketPar = new ParameterBuilder();
+        List<Parameter> pars = new ArrayList<>();
+        ticketPar.name(tokenHeader).description("token")
+                .modelRef(new ModelRef("string"))
+                .parameterType("header")
+                .defaultValue(tokenStartWith + " ")
+                .required(true)
+                .build();
+        pars.add(ticketPar.build());
+        return new Docket(DocumentationType.SWAGGER_2)
+                .enable(enabled)
+                .apiInfo(apiInfo())
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("co.yixiang.modules"))
+                .paths(Predicates.not(PathSelectors.regex("/error.*")))
+                .build()
+                .globalOperationParameters(pars);
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title(title)
+                .termsOfServiceUrl(serverUrl)
+                .description(title)
+                .version(version)
+                .contact("610796224@qq.com")
+                .build();
+    }
+
+}
+
+/**
+ *  将Pageable转换展示在swagger中
+ */
+@Configuration
+class SwaggerDataConfig {
+
+    @Bean
+    public AlternateTypeRuleConvention pageableConvention(final TypeResolver resolver) {
+        return new AlternateTypeRuleConvention() {
+            @Override
+            public int getOrder() {
+                return Ordered.HIGHEST_PRECEDENCE;
+            }
+
+            @Override
+            public List<AlternateTypeRule> rules() {
+                return newArrayList(newRule(resolver.resolve(Pageable.class), resolver.resolve(Page.class)));
+            }
+        };
+    }
+
+    @ApiModel
+    @Data
+    private static class Page {
+        @ApiModelProperty("页码 (0..N)")
+        private Integer page;
+
+        @ApiModelProperty("每页显示的数目")
+        private Integer size;
+
+        @ApiModelProperty("以下列格式排序标准：property[,asc | desc]。 默认排序顺序为升序。 支持多种排序条件：如：id,asc")
+        private List<String> sort;
+    }
+}