Merge pull request #38 from JeffLi1993/master

支持全局响应消息

Author: 程序猿DD-翟永超

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.spring4all</groupId>
     <artifactId>spring-boot-starter-swagger</artifactId>
-    <version>1.5.1.RELEASE</version>
+    <version>1.6.0-SNAPSHOT</version>
 
     <name>spring-boot-starter-swagger</name>
     <url>https://github.com/SpringForAll/spring-boot-starter-swagger</url>
@@ -84,6 +84,11 @@
             <version>1.16.12</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>

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

@@ -12,15 +12,15 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import springfox.documentation.builders.ApiInfoBuilder;
-import springfox.documentation.builders.ParameterBuilder;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
+import org.springframework.util.StringUtils;
+import springfox.documentation.builders.*;
 import springfox.documentation.schema.ModelRef;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.service.Parameter;
+import springfox.documentation.service.ResponseMessage;
 import springfox.documentation.spi.DocumentationType;
+import org.springframework.web.bind.annotation.RequestMethod;
 import springfox.documentation.spring.web.plugins.Docket;
 
 import java.util.*;
@@ -82,21 +82,25 @@ public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
                 excludePath.add(PathSelectors.ant(path));
             }
 
-            Docket docket = new Docket(DocumentationType.SWAGGER_2)
+            Docket docketForBuilder = new Docket(DocumentationType.SWAGGER_2)
                     .host(swaggerProperties.getHost())
                     .apiInfo(apiInfo)
                     .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(
-                            swaggerProperties.getGlobalOperationParameters()))
-                    .select()
+                            swaggerProperties.getGlobalOperationParameters()));
+
+            // 全局响应消息
+            if (!swaggerProperties.getApplyDefaultResponseMessages()) {
+                buildGlobalResponseMessage(swaggerProperties, docketForBuilder);
+            }
+
+            Docket docket = docketForBuilder.select()
                     .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                     .paths(
                             Predicates.and(
                                     Predicates.not(Predicates.or(excludePath)),
                                     Predicates.or(basePath)
                             )
-                    )
-                    .build();
-
+                    ).build();
             configurableBeanFactory.registerSingleton("defaultDocket", docket);
             docketList.add(docket);
             return docketList;
@@ -138,12 +142,18 @@ public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
                 excludePath.add(PathSelectors.ant(path));
             }
 
-            Docket docket = new Docket(DocumentationType.SWAGGER_2)
+            Docket docketForBuilder = new Docket(DocumentationType.SWAGGER_2)
                     .host(swaggerProperties.getHost())
                     .apiInfo(apiInfo)
-                    .globalOperationParameters(assemblyGlobalOperationParameters(swaggerProperties.getGlobalOperationParameters(),
-                            docketInfo.getGlobalOperationParameters()))
-                    .groupName(groupName)
+                    .globalOperationParameters(buildGlobalOperationParametersFromSwaggerProperties(
+                            swaggerProperties.getGlobalOperationParameters()));
+
+            // 全局响应消息
+            if (!swaggerProperties.getApplyDefaultResponseMessages()) {
+                buildGlobalResponseMessage(swaggerProperties, docketForBuilder);
+            }
+
+            Docket docket = docketForBuilder.groupName(groupName)
                     .select()
                     .apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
                     .paths(
@@ -160,11 +170,15 @@ public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
         return docketList;
     }
 
+
+
     @Override
     public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
         this.beanFactory = beanFactory;
     }
 
+
+
     private List<Parameter> buildGlobalOperationParametersFromSwaggerProperties(
             List<SwaggerProperties.GlobalOperationParameter> globalOperationParameters) {
         List<Parameter> parameters = Lists.newArrayList();
@@ -216,4 +230,31 @@ private List<Parameter> assemblyGlobalOperationParameters(
         resultOperationParameters.addAll(docketOperationParameters);
         return buildGlobalOperationParametersFromSwaggerProperties(resultOperationParameters);
     }
+
+    /**
+     * 设置全局响应消息
+     *
+     * @param swaggerProperties
+     * @param docketForBuilder
+     */
+    private void buildGlobalResponseMessage(SwaggerProperties swaggerProperties, Docket docketForBuilder) {
+        List<ResponseMessage> responseMessages = new ArrayList();
+        List<SwaggerProperties.GlobalResponseMessage> globalResponseMessages =
+                swaggerProperties.getGlobalResponseMessages();
+        for (SwaggerProperties.GlobalResponseMessage globalResponseMessage : globalResponseMessages) {
+            ResponseMessageBuilder responseMessageBuilder = new ResponseMessageBuilder();
+            responseMessageBuilder
+                    .code(globalResponseMessage.getCode())
+                    .message(globalResponseMessage.getMessage());
+
+            if (!StringUtils.isEmpty(globalResponseMessage.getModelRef())) {
+                responseMessageBuilder
+                        .responseModel(new ModelRef(globalResponseMessage.getModelRef()));
+            }
+            responseMessages.add(responseMessageBuilder.build());
+        }
+
+        docketForBuilder.useDefaultResponseMessages(swaggerProperties.getApplyDefaultResponseMessages())
+                .globalResponseMessage(RequestMethod.GET,responseMessages);
+    }
 }

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

@@ -54,6 +54,11 @@ public class SwaggerProperties {
     /**全局参数配置**/
     private List<GlobalOperationParameter> globalOperationParameters;
 
+    /** 是否使用默认预定义的响应消息 ，默认 true **/
+    private Boolean applyDefaultResponseMessages = true;
+
+    /** 全局响应消息 ，目前支持 GET **/
+    private List<GlobalResponseMessage> globalResponseMessages;
 
     @Data
     @NoArgsConstructor
@@ -119,6 +124,20 @@ public static class Contact {
 
     }
 
+    @Data
+    @NoArgsConstructor
+    public static class GlobalResponseMessage {
+
+        /** 响应码 **/
+        private int code;
+
+        /** 响应消息 **/
+        private String message;
+
+        /** 响应体 **/
+        private String modelRef;
+    }
+
 }