update 接口文档 支持分组配置

ruoyi-admin/src/main/resources/application.yml

@@ -243,6 +243,11 @@ swagger:
     name: Lion Li
     email: crazylionli@163.com
     url: https://gitee.com/JavaLionLi/RuoYi-Vue-Plus
+  groups:
+    - name: 演示案例
+      basePackage: com.ruoyi.demo
+    - name: 系统模块
+      basePackage: com.ruoyi.admin
 
 # 防止XSS攻击
 xss:

ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java

@@ -1,11 +1,12 @@
 package com.ruoyi.framework.config;
 
 import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
+import com.ruoyi.common.properties.TokenProperties;
+import com.ruoyi.common.utils.StringUtils;
+import com.ruoyi.common.utils.spring.SpringUtils;
 import com.ruoyi.framework.config.properties.SwaggerProperties;
-import io.swagger.annotations.ApiOperation;
 import io.swagger.models.auth.In;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
@@ -15,6 +16,7 @@ import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spi.service.contexts.SecurityContext;
 import springfox.documentation.spring.web.plugins.Docket;
 
+import javax.annotation.PostConstruct;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -30,28 +32,37 @@ public class SwaggerConfig {
     @Autowired
     private SwaggerProperties swaggerProperties;
 
+    @Autowired
+	private TokenProperties tokenProperties;
+
     /**
      * 创建API
      */
-	@Bean
-	public Docket createRestApi() {
-		return new Docket(DocumentationType.OAS_30)
+    @PostConstruct
+    public void createRestApi() {
+		for (SwaggerProperties.Groups group : swaggerProperties.getGroups()) {
+			String basePackage = group.getBasePackage();
+			Docket docket = new Docket(DocumentationType.OAS_30)
 					.enable(swaggerProperties.getEnabled())
 					// 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
 					.apiInfo(apiInfo())
 					// 设置哪些接口暴露给Swagger展示
 					.select()
 					// 扫描所有有注解的api，用这种方式更灵活
-			.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+					//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
 					// 扫描指定包中的swagger注解
-			// .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
+					.apis(RequestHandlerSelectors.basePackage(basePackage))
 					// 扫描所有 .apis(RequestHandlerSelectors.any())
 					.paths(PathSelectors.any())
 					.build()
-			/* 设置安全模式，swagger可以设置访问token */
+					.groupName(group.getName())
+					// 设置安全模式，swagger可以设置访问token
 					.securitySchemes(securitySchemes())
 					.securityContexts(securityContexts())
 					.pathMapping(swaggerProperties.getPathMapping());
+			String beanName = StringUtils.substringAfterLast(basePackage, ".") + "Docket";
+			SpringUtils.registerBean(beanName, docket);
+		}
     }
 
     /**
@@ -59,7 +70,8 @@ public class SwaggerConfig {
      */
     private List<SecurityScheme> securitySchemes() {
         List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
-		apiKeyList.add(new ApiKey("Authorization", "Authorization", In.HEADER.toValue()));
+		String header = tokenProperties.getHeader();
+		apiKeyList.add(new ApiKey(header, header, In.HEADER.toValue()));
         return apiKeyList;
     }
 
@@ -84,7 +96,7 @@ public class SwaggerConfig {
         AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
         authorizationScopes[0] = authorizationScope;
         List<SecurityReference> securityReferences = new ArrayList<>();
-		securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
+        securityReferences.add(new SecurityReference(tokenProperties.getHeader(), authorizationScopes));
         return securityReferences;
     }
 

ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java

@@ -5,6 +5,8 @@ import lombok.NoArgsConstructor;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 
+import java.util.List;
+
 /**
  * swagger 配置属性
  *
@@ -41,23 +43,46 @@ public class SwaggerProperties {
 	 */
     private Contact contact;
 
+	/**
+	 * 组配置
+	 */
+	private List<Groups> groups;
+
     @Data
 	@NoArgsConstructor
-	public static class Contact{
+	public static class Contact {
 
 		/**
 		 * 联系人
-		 **/
+		 */
 		private String name;
+
 		/**
 		 * 联系人url
-		 **/
+		 */
 		private String url;
+
 		/**
 		 * 联系人email
-		 **/
+		 */
 		private String email;
 
 	}
 
+	@Data
+	@NoArgsConstructor
+	public static class Groups {
+
+		/**
+		 * 组名
+		 */
+		private String name;
+
+		/**
+		 * 基础包路径
+		 */
+		private String basePackage;
+
+	}
+
 }