fix: Adding global Configuration

Author: llin6025

src/main/java/com/spring4all/swagger/DocketConfiguration.java

@@ -1,8 +1,8 @@
 package com.spring4all.swagger;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
+import static com.google.common.collect.Lists.newArrayList;
+
+import java.util.*;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
@@ -19,12 +19,14 @@
 
 import com.google.common.base.Predicates;
 
+import org.springframework.context.annotation.DependsOn;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.builders.RequestParameterBuilder;
 import springfox.documentation.schema.ScalarType;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
+import springfox.documentation.service.ParameterType;
 import springfox.documentation.service.RequestParameter;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
@@ -70,8 +72,10 @@ public void createSpringFoxRestApi() {
 
             Docket docket4Group = (Docket)beanFactory.getBean(beanName);
             ApiInfo apiInfo = apiInfo(swaggerProperties);
-            docket4Group.host(swaggerProperties.getHost()).apiInfo(apiInfo).select()
-                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
+            docket4Group.host(swaggerProperties.getHost()).apiInfo(apiInfo)
+                .globalRequestParameters(
+                    assemblyRequestParameters(swaggerProperties.getGlobalOperationParameters(), new ArrayList<>()))
+                .select().apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                 .paths(paths(swaggerProperties.getBasePath(), swaggerProperties.getExcludePath())).build();
             return;
         }
@@ -124,28 +128,64 @@ public void createSpringFoxRestApi() {
             beanRegistry.registerBeanDefinition(beanName, beanDefinition4Group);
 
             Docket docket4Group = (Docket)beanFactory.getBean(beanName);
-            docket4Group.groupName(groupName).host(docketInfo.getBasePackage()).apiInfo(apiInfo).select()
-                .apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
+            docket4Group.groupName(groupName).host(docketInfo.getBasePackage()).apiInfo(apiInfo)
+                .globalRequestParameters(assemblyRequestParameters(swaggerProperties.getGlobalOperationParameters(),
+                    docketInfo.getGlobalOperationParameters()))
+                .select().apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
                 .paths(paths(docketInfo.getBasePath(), docketInfo.getExcludePath())).build();
         }
     }
 
     /**
      * 全局请求参数
      *
-     * @param swaggerProperties
+     * @param properties
      *            {@link SwaggerProperties}
      * @return RequestParameter {@link RequestParameter}
      */
-    private List<RequestParameter> globalRequestParameters(SwaggerProperties swaggerProperties) {
-        return swaggerProperties.getGlobalOperationParameters().stream()
+    private List<RequestParameter> getRequestParameters(List<SwaggerProperties.GlobalOperationParameter> properties) {
+        return properties.stream()
             .map(param -> new RequestParameterBuilder().name(param.getName()).description(param.getDescription())
-                .in(param.getParameterType()).required(param.getRequired())
-                .query(q -> q.defaultValue(param.getModelRef()))
-                .query(q -> q.model(m -> m.scalarModel(ScalarType.STRING))).build())
+                .in(ParameterType.from(param.getParameterType())).required(param.getRequired())
+                .query(q -> q.defaultValue(param.getType()))
+                .query(q -> q.model(m -> m.scalarModel(!ScalarType.from(param.getType(), param.getFormat()).isPresent()
+                    ? ScalarType.STRING : ScalarType.from(param.getType(), param.getFormat()).get())))
+                .build())
             .collect(Collectors.toList());
     }
 
+    /**
+     * 局部参数按照name覆盖局部参数
+     *
+     * @param globalRequestParameters
+     * @param groupRequestParameters
+     * @return
+     */
+    private List<RequestParameter> assemblyRequestParameters(
+        List<SwaggerProperties.GlobalOperationParameter> globalRequestParameters,
+        List<SwaggerProperties.GlobalOperationParameter> groupRequestParameters) {
+
+        if (Objects.isNull(groupRequestParameters) || groupRequestParameters.isEmpty()) {
+            return getRequestParameters(globalRequestParameters);
+        }
+
+        Set<String> paramNames = groupRequestParameters.stream()
+            .map(SwaggerProperties.GlobalOperationParameter::getName).collect(Collectors.toSet());
+
+        List<SwaggerProperties.GlobalOperationParameter> requestParameters = newArrayList();
+
+        if (Objects.nonNull(globalRequestParameters)) {
+            for (SwaggerProperties.GlobalOperationParameter parameter : globalRequestParameters) {
+                if (!paramNames.contains(parameter.getName())) {
+                    requestParameters.add(parameter);
+                }
+            }
+        }
+
+        requestParameters.addAll(groupRequestParameters);
+        return getRequestParameters(requestParameters);
+    }
+
     /**
      * API接口路径选择
      *

src/main/java/com/spring4all/swagger/SwaggerProperties.java

@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 import lombok.Data;
@@ -106,7 +107,13 @@ public static class GlobalOperationParameter {
         /**
          * 指定参数类型
          **/
-        private String modelRef;
+        @Value("modelRef")
+        private String type;
+
+        /**
+         * 指定参数类型
+         **/
+        private String format = "";
 
         /**
          * 参数放在哪个地方:header,query,path,formData,cookie,form
@@ -116,7 +123,7 @@ public static class GlobalOperationParameter {
         /**
          * 参数是否必须传
          **/
-        private Boolean required;
+        private Boolean required = false;
 
     }