#12 增加“try it out”按钮的开关控制

Author: dyc87112

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.spring4all</groupId>
-    <artifactId>spring-boot-starter-swagger</artifactId>
+    <artifactId>swagger-spring-boot-starter</artifactId>
     <version>1.6.0-SNAPSHOT</version>
 
     <name>spring-boot-starter-swagger</name>

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

@@ -7,21 +7,23 @@
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.util.StringUtils;
+import org.springframework.web.bind.annotation.RequestMethod;
 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 springfox.documentation.swagger.web.UiConfiguration;
 
 import java.util.*;
 import java.util.stream.Collectors;
@@ -45,8 +47,22 @@ public SwaggerProperties swaggerProperties() {
         return new SwaggerProperties();
     }
 
+    @Bean
+    public UiConfiguration uiConfiguration(SwaggerProperties swaggerProperties) {
+        return new UiConfiguration(
+                swaggerProperties.getUiConfig().getValidatorUrl(),// url
+                swaggerProperties.getUiConfig().getDocExpansion(),       // docExpansion          => none | list
+                swaggerProperties.getUiConfig().getApiSorter(),      // apiSorter             => alpha
+                swaggerProperties.getUiConfig().getDefaultModelRendering(),     // defaultModelRendering => schema
+                swaggerProperties.getUiConfig().getSubmitMethods().split(","),
+                swaggerProperties.getUiConfig().getJsonEditor(),        // enableJsonEditor      => true | false
+                swaggerProperties.getUiConfig().getShowRequestHeaders(),         // showRequestHeaders    => true | false
+                swaggerProperties.getUiConfig().getRequestTimeout());      // requestTimeout => in milliseconds, defaults to null (uses jquery xh timeout)
+    }
+
     @Bean
     @ConditionalOnMissingBean
+    @ConditionalOnBean(UiConfiguration.class)
     @ConditionalOnProperty(name = "swagger.enabled", matchIfMissing = true)
     public List<Docket> createRestApi(SwaggerProperties swaggerProperties) {
         ConfigurableBeanFactory configurableBeanFactory = (ConfigurableBeanFactory) beanFactory;

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

@@ -53,12 +53,16 @@ public class SwaggerProperties {
     /**全局参数配置**/
     private List<GlobalOperationParameter> globalOperationParameters;
 
+    /** 页面功能配置 **/
+    private UiConfig uiConfig = new UiConfig();
+
     /** 是否使用默认预定义的响应消息 ，默认 true **/
     private Boolean applyDefaultResponseMessages = true;
 
     /** 全局响应消息 **/
     private GlobalResponseMessage globalResponseMessage;
 
+
     @Data
     @NoArgsConstructor
     public static class GlobalOperationParameter{
@@ -168,6 +172,27 @@ public static class GlobalResponseMessageBody {
 
     }
 
+
+    @Data
+    @NoArgsConstructor
+    public static class UiConfig {
+
+        private String validatorUrl;
+        private String docExpansion = "none";    // none | list
+        private String apiSorter = "alpha";       // alpha
+        private String defaultModelRendering = "schema";   // schema
+
+        /** 是否启用json编辑器 **/
+        private Boolean jsonEditor = false;
+        /** 是否显示请求头信息 **/
+        private Boolean showRequestHeaders = true;
+        /** 支持页面提交的请求类型 **/
+        private String submitMethods = "get,post,put,delete,patch";
+        /** 请求超时时间 **/
+        private Long requestTimeout = 10000L;
+
+    }
+
 }