first

pom.xml

@@ -215,7 +215,12 @@
             <artifactId>gexin-rp-sdk-http</artifactId>
             <version>4.1.0.5</version>
         </dependency>
-
+        <!-- 重写Swagger-UI -->
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>swagger-bootstrap-ui</artifactId>
+            <version>1.9.6</version>
+        </dependency>
     </dependencies>
 
     <repositories>

src/main/java/com/hwstudio/antaile/config/SwaggerConfig.java

 package com.hwstudio.antaile.config;
 
+import io.swagger.annotations.ApiOperation;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
@@ -7,10 +9,9 @@ import springfox.documentation.builders.ParameterBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.schema.ModelRef;
-import springfox.documentation.service.ApiInfo;
-import springfox.documentation.service.Contact;
-import springfox.documentation.service.Parameter;
+import springfox.documentation.service.*;
 import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.contexts.SecurityContext;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@@ -27,40 +28,83 @@ import java.util.List;
 @EnableSwagger2
 public class SwaggerConfig {
 
-//    public Docket createRestApi() {
-//        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
-//                .select()
-//                .apis(RequestHandlerSelectors.basePackage("com.jains.controller"))
-//                .paths(PathSelectors.any()).build();
-//    }
-//
-//    private ApiInfo apiInfo() {
-//        return new ApiInfoBuilder().title("janis Manger Swagger RSETful APIs")
-//                .description("综合管理 Swagger API 服务")
-//                .termsOfServiceUrl("http://swagger.io/")
-//                .contact(new Contact("janis", "127.0.0.1", "jains@163.com.cn"))
-//                .version("1.0")
-//                .build();
-//    }
+    /**
+     * 是否开启swagger
+     */
+    @Value("${swagger.enabled}")
+    private boolean enabled;
+
+    /**
+     * 设置请求的统一前缀
+     */
+    @Value("${swagger.pathMapping}")
+    private String pathMapping;
 
+    /**
+     * 创建API
+     */
     @Bean
-    public Docket buildDocket() {
-        ParameterBuilder tokenPar = new ParameterBuilder();
-        List<Parameter> pars = new ArrayList<Parameter>();
-        tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
-        pars.add(tokenPar.build());
-        //添加head参数end
+    public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
-                .apiInfo(buildApiInf())
+                // 是否启用Swagger
+                .enable(enabled)
+                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
+                .apiInfo(apiInfo())
+                // 设置哪些接口暴露给Swagger展示
                 .select()
-                .apis(RequestHandlerSelectors.basePackage("com.hwstudio.antaile.controller"))
+                // 扫描所有有注解的api，用这种方式更灵活
+                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+                // 扫描指定包中的swagger注解
+                // .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
+                // 扫描所有 .apis(RequestHandlerSelectors.any())
                 .paths(PathSelectors.any())
                 .build()
-                .globalOperationParameters(pars);
+                /* 设置安全模式，swagger可以设置访问token */
+                .securitySchemes(securitySchemes())
+                .securityContexts(securityContexts())
+                .pathMapping(pathMapping);
+    }
+
+    /**
+     * 安全模式，这里指定token通过Authorization头请求头传递
+     */
+    private List<ApiKey> securitySchemes() {
+        List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
+        apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
+        return apiKeyList;
+    }
+
+    /**
+     * 安全上下文
+     */
+    private List<SecurityContext> securityContexts() {
+        List<SecurityContext> securityContexts = new ArrayList<>();
+        securityContexts.add(
+                SecurityContext.builder()
+                        .securityReferences(defaultAuth())
+                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
+                        .build());
+        return securityContexts;
+    }
+
+    /**
+     * 默认的安全上引用
+     */
+    private List<SecurityReference> defaultAuth() {
+        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
+        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
+        authorizationScopes[0] = authorizationScope;
+        List<SecurityReference> securityReferences = new ArrayList<>();
+        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
+        return securityReferences;
     }
 
-    private ApiInfo buildApiInf() {
-        return new ApiInfoBuilder().title("安泰乐接口文档").termsOfServiceUrl("#").description("").version("0.1").build();
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder().title("安泰乐app手机端-接口文档")
+                .termsOfServiceUrl("#")
+                .description("描述：用于app手机端-端开发人员测试，以及调试请求接口")
+                .version("1.0")
+                .build();
 
     }
 }

src/main/resources/application.yml

@@ -113,9 +113,15 @@ mybatis:
 #  support-methods-arguments: true
 #  params: count=countSql
 
-
 logging:
   level:
     com.hwstudio.antaile.mapper: debug
   config:
     classpath:Logback.xml
+
+# Swagger配置
+swagger:
+  # 是否开启swagger
+  enabled: true
+  # 请求前缀
+  pathMapping: / #dev-api