🚀 优化swagger接文档，界面采用knife4j风格

Author: Janche

README.md

@@ -7,7 +7,7 @@
 3. spring-security目前使用的是基于权限的动态校验，采用黑名单的方式对接口权限的判断。
 4. 框架内已包含许多工具类，MD5加密、json、POI的excel文档操作，以及时间和日期等常见工具类。
 5. 采用了@Log对项目日志的记录。
-6. 接口文档地址：http://localhost:9999/swagger-ui.html
+6. 接口文档地址：http://localhost:9999/doc.html(采用knife4j的文档风格)
 7. 加入对OAuth2的支持 （[博客地址](https://blog.csdn.net/qq_34997906/article/details/89600076)）
 
 |依赖            |版本         |

swagger/pom.xml

@@ -11,26 +11,11 @@
 
     <artifactId>swagger</artifactId>
     <dependencies>
+        <!-- knife4j 替代swagger显示接口文档 -->
         <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger2</artifactId>
-            <version>2.8.0</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>com.google.guava</groupId>
-                    <artifactId>guava</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>org.javassist</groupId>
-                    <artifactId>javassist</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
-        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger-ui</artifactId>
-            <version>2.8.0</version>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>2.0.5</version>
         </dependency>
     </dependencies>
 

swagger/src/main/java/com/example/janche/swagger/SwaggerConfig.java

@@ -1,9 +1,12 @@
 package com.example.janche.swagger;
 
+import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
@@ -14,11 +17,13 @@
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 @Configuration
-@EnableSwagger2
+@EnableKnife4j
+@Import(BeanValidatorPluginsConfiguration.class)
 @EnableConfigurationProperties(SwaggerProperties.class)
 public class SwaggerConfig {
     @Autowired
     private SwaggerProperties swaggerProperties;
+
     @Bean
     public Docket api() {
         return new Docket(DocumentationType.SWAGGER_2)
@@ -32,15 +37,15 @@ public Docket api() {
 
     private ApiInfo apiInfo() {
         ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder();
-        if(swaggerProperties.getTitle()!=null){
+        if (swaggerProperties.getTitle() != null) {
             apiInfoBuilder.title(swaggerProperties.getTitle());
         }
-        if(swaggerProperties.getContractName()!=null&&swaggerProperties.getContractUrl()!=null&&
-                swaggerProperties.getContractEmail()!=null){
+        if (swaggerProperties.getContractName() != null && swaggerProperties.getContractUrl() != null
+                && swaggerProperties.getContractEmail() != null) {
             apiInfoBuilder.contact(new Contact(swaggerProperties.getContractName(), swaggerProperties.getContractUrl(),
                     swaggerProperties.getContractEmail()));
         }
-        if(swaggerProperties.getVersion()!=null){
+        if (swaggerProperties.getVersion() != null) {
             apiInfoBuilder.version(swaggerProperties.getVersion());
         }
         return apiInfoBuilder.build();

web/src/main/resources/application-dev.yml

@@ -108,7 +108,10 @@ mapper:
 # 日志
 logging.config: classpath:logging-spring.xml
 swagger:
-  title: 接口文档
+  title: 脚手架接口文档
   basepackage: com.example.janche
   version: 1.0.0
+  contract-name: Janche
+  contract-url: https://blog.csdn.net/qq_34997906
+  contract-email: [email protected]
 

web/src/main/resources/application-sysconfig.yml

@@ -32,6 +32,7 @@ custom:
         - "/v2/**"
         - "/webjars/**"
         - "/swagger-resources/**"
+        - "/doc.html"
 
 # 热部署插件指定端口,具体视自己情况而定,只要不重复就可以，默认是35729
 spring: