1.4.0 完善分组配置和文档

Author: renlulu

README.md

@@ -102,6 +102,7 @@ swagger.globalOperationParameters[1].required=false
 - swagger.globalOperationParameters[0].required=指定参数是否必传，true,false
 ```
 
+
 > host属性从1.3.0.RELEASE开始支持
 
 ### Path规则说明
@@ -148,10 +149,15 @@ swagger.exclude-path=/ops/**, /error
 - swagger.docket.<name>.modelRef=指定参数类型
 - swagger.docket.<name>.parameterType=指定参数存放位置,可选header,query,path,body.form
 - swagger.docket.<name>.required=true=指定参数是否必传，true,false
+- swagger.docket.<name>.globalOperationParameters[0].name=参数名
+- swagger.docket.<name>.globalOperationParameters[0].description=描述信息
+- swagger.docket.<name>.globalOperationParameters[0].modelRef=指定参数存放位置,可选header,query,path,body.form
+- swagger.docket.<name>.globalOperationParameters[0].parameterType=指定参数是否必传，true,false
 ```
 
 说明：`<name>`为swagger文档的分组名称，同一个项目中可以配置多个分组，用来划分不同的API文档。
 
+
 **分组配置示例**
 
 ```properties
@@ -163,13 +169,21 @@ swagger.docket.aaa.contact.name=zhaiyongchao
 swagger.docket.aaa.contact.url=http://spring4all.com/
 swagger.docket.aaa.contact.email[email protected]
 swagger.docket.aaa.excludePath=/ops/**
+swagger.docket.aaa.globalOperationParameters[0].name=name three
+swagger.docket.aaa.globalOperationParameters[0].description=some description three override
+swagger.docket.aaa.globalOperationParameters[0].modelRef=string
+swagger.docket.aaa.globalOperationParameters[0].parameterType=header
 
 swagger.docket.bbb.title=group-bbb
 swagger.docket.bbb.basePackage=com.yonghui
+
+
 ```
 
 说明：默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代，所以默认配置可以作为分组配置公共部分属性的配置。
 
+`swagger.docket.aaa.globalOperationParameters[0].name` 会覆盖同名的全局配置
+
 ### JSR-303校验注解支持
 
 支持对JSR-303校验注解的展示，如下图所示：

src/main/java/com/didispace/swagger/SwaggerAutoConfiguration.java

@@ -24,6 +24,8 @@
 import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * @author 翟永超
@@ -80,7 +82,8 @@ public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
             Docket docket = new Docket(DocumentationType.SWAGGER_2)
                     .host(swaggerProperties.getHost())
                     .apiInfo(apiInfo)
-                    .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(swaggerProperties))
+                    .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(
+                            swaggerProperties.getGlobalOperationParameters()))
                     .select()
                     .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                     .paths(
@@ -135,7 +138,8 @@ public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
             Docket docket = new Docket(DocumentationType.SWAGGER_2)
                     .host(swaggerProperties.getHost())
                     .apiInfo(apiInfo)
-                    .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(swaggerProperties))
+                    .globalOperationParameters(assemblyGlobalOperationParameters(swaggerProperties.getGlobalOperationParameters(),
+                            docketInfo.getGlobalOperationParameters()))
                     .groupName(groupName)
                     .select()
                     .apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
@@ -158,17 +162,48 @@ public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
         this.beanFactory = beanFactory;
     }
 
-    private List<Parameter> buildGlobalOperationParametersFromSwaggerProperties(SwaggerProperties swaggerProperties) {
+    private List<Parameter> buildGlobalOperationParametersFromSwaggerProperties(
+            List<SwaggerProperties.GlobalOperationParameter> globalOperationParameters) {
         List<Parameter> parameters = Lists.newArrayList();
-        for (int i = 0; i < swaggerProperties.getGlobalOperationParameters().size(); i++) {
+        for (SwaggerProperties.GlobalOperationParameter globalOperationParameter : globalOperationParameters) {
             parameters.add(new ParameterBuilder()
-                    .name(swaggerProperties.getGlobalOperationParameters().get(i).getName())
-                    .description(swaggerProperties.getGlobalOperationParameters().get(i).getDescription())
-                    .modelRef(new ModelRef(swaggerProperties.getGlobalOperationParameters().get(i).getModelRef()))
-                    .parameterType(swaggerProperties.getGlobalOperationParameters().get(i).getParameterType())
-                    .required(Boolean.parseBoolean(swaggerProperties.getGlobalOperationParameters().get(i).getRequired()))
+                    .name(globalOperationParameter.getName())
+                    .description(globalOperationParameter.getDescription())
+                    .modelRef(new ModelRef(globalOperationParameter.getModelRef()))
+                    .parameterType(globalOperationParameter.getParameterType())
+                    .required(Boolean.parseBoolean(globalOperationParameter.getRequired()))
                     .build());
         }
         return parameters;
     }
+
+    /**
+     * 局部参数按照name覆盖局部参数
+     *
+     * @param globalOperationParameters
+     * @param docketOperationParameters
+     * @return
+     */
+    private List<Parameter> assemblyGlobalOperationParameters(
+            List<SwaggerProperties.GlobalOperationParameter> globalOperationParameters,
+            List<SwaggerProperties.GlobalOperationParameter> docketOperationParameters) {
+
+        if (docketOperationParameters == null || docketOperationParameters.isEmpty()) {
+            return buildGlobalOperationParametersFromSwaggerProperties(globalOperationParameters);
+        }
+
+        Set<String> docketNames = docketOperationParameters.stream()
+                .map(SwaggerProperties.GlobalOperationParameter::getName)
+                .collect(Collectors.toSet());
+
+        List<SwaggerProperties.GlobalOperationParameter> resultOperationParameters = Lists.newArrayList();
+
+        for (SwaggerProperties.GlobalOperationParameter parameter : globalOperationParameters) {
+            if (!docketNames.contains(parameter.getName())) {
+                resultOperationParameters.add(parameter);
+            }
+        }
+        resultOperationParameters.addAll(docketOperationParameters);
+        return buildGlobalOperationParametersFromSwaggerProperties(resultOperationParameters);
+    }
 }

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

@@ -54,7 +54,6 @@ public class SwaggerProperties {
 
     @Data
     @NoArgsConstructor
-    @ConfigurationProperties("swagger.globalOperationParameters")
     public static class GlobalOperationParameter{
         /**参数名**/
         private String name;
@@ -70,6 +69,7 @@ public static class GlobalOperationParameter{
 
         /**参数是否必须传**/
         private String required;
+
     }
 
     @Data
@@ -99,6 +99,8 @@ public static class DocketInfo {
         /**在basePath基础上需要排除的url规则**/
         private List<String> excludePath = new ArrayList<>();
 
+        private List<GlobalOperationParameter> globalOperationParameters;
+
     }
 
     @Data