update 接口文档 支持分组配置

疯狂的狮子li

2021-09-26 3434610349c93037e9fc565600b151e0aed1672e

 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.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 @@
   @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 @@
    */
   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 @@
      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;
   }