标签：Knife4j String ruoyi new springdoc org import swagger

1.将旧版swagger依赖去掉

2.添加knife4j依赖

主依赖Pom里添加

        <springdoc.version>1.6.15</springdoc.version>
        <knife4j.version>4.3.0</knife4j.version>

            <!--knife4j接口文档-->
          <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
            <version>${knife4j.version}</version>
          </dependency>

          <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>${springdoc.version}</version>
          </dependency>

2.1在ruoyi-common添加依赖引用，也可以放在ruoyi-framework里

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
        </dependency>

3.添加配置文件

3.1删除原本的swagger配置

3.2在common里添加两个配置文件

新建一个swagger

SwaggerConfig

package com.ruoyi.common.swagger;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.media.StringSchema;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import io.swagger.v3.oas.models.security.SecurityScheme.In;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.springdoc.core.GroupedOpenApi;
import org.springdoc.core.OpenAPIService;
import org.springdoc.core.PropertyResolverUtils;
import org.springdoc.core.SecurityService;
import org.springdoc.core.SpringDocConfigProperties;
import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
import org.springdoc.core.providers.JavadocProvider;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpHeaders;

/**
 * Swagger 自动配置类，基于 OpenAPI + Springdoc 实现。
 *
 * 友情提示：
 * 1. Springdoc 文档地址：<a href="https://github.com/springdoc/springdoc-openapi">仓库</a>
 * 2. Swagger 规范，于 2015 更名为 OpenAPI 规范，本质是一个东西
 *
 */
// @AutoConfiguration
@Configuration
@ConditionalOnClass({OpenAPI.class})
@EnableConfigurationProperties(SwaggerProperties.class)
@ConditionalOnProperty(prefix = "springdoc.api-docs", name = "enabled", havingValue = "true", matchIfMissing = true) // 设置为 false 时，禁用
public class SwaggerConfig
{

    public static final String HEADER_TENANT_ID = "tenant-id";


  // ========== 全局 OpenAPI 配置 ==========

  @Bean
  public OpenAPI createApi(SwaggerProperties properties) {
    Map<String, SecurityScheme> securitySchemas = buildSecuritySchemes();
    OpenAPI openAPI = new OpenAPI()
        // 接口信息
        .info(buildInfo(properties))
        // 接口安全配置
        .components(new Components().securitySchemes(securitySchemas))
        .addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION));
    securitySchemas.keySet().forEach(key -> openAPI.addSecurityItem(new SecurityRequirement().addList(key)));
    return openAPI;
  }

  /**
   * API 摘要信息
   */
  private Info buildInfo(SwaggerProperties properties) {
    return new Info()
        .title(properties.getTitle())
        .description(properties.getDescription())
        .version(properties.getVersion())
        .contact(new Contact().name(properties.getAuthor()).url(properties.getUrl()).email(properties.getEmail()))
        .license(new License().name(properties.getLicense()).url(properties.getLicenseUrl()));
  }

  /**
   * 安全模式，这里配置通过请求头 Authorization 传递 token 参数
   */
  private Map<String, SecurityScheme> buildSecuritySchemes() {
    Map<String, SecurityScheme> securitySchemes = new HashMap<>();
    SecurityScheme securityScheme = new SecurityScheme()
        .type(SecurityScheme.Type.APIKEY) // 类型
        .name(HttpHeaders.AUTHORIZATION) // 请求头的 name
        .in(SecurityScheme.In.HEADER); // token 所在位置
    securitySchemes.put(HttpHeaders.AUTHORIZATION, securityScheme);
    return securitySchemes;
  }

  /**
   * 自定义 OpenAPI 处理器
   */
  @Bean
  public OpenAPIService openApiBuilder(Optional<OpenAPI> openAPI,
      SecurityService securityParser,
      SpringDocConfigProperties springDocConfigProperties,
      PropertyResolverUtils propertyResolverUtils,
      Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomizers,
      Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers,
      Optional<JavadocProvider> javadocProvider) {

    return new OpenAPIService(openAPI, securityParser, springDocConfigProperties,
        propertyResolverUtils, openApiBuilderCustomizers, serverBaseUrlCustomizers, javadocProvider);
  }

  // ========== 分组 OpenAPI 配置 ==========

  /**
   * 所有模块的 API 分组
   */
  @Bean
  public GroupedOpenApi allGroupedOpenApi() {
    return buildGroupedOpenApi("all", "");
  }

  public static GroupedOpenApi buildGroupedOpenApi(String group) {
    return buildGroupedOpenApi(group, group);
  }

  public static GroupedOpenApi buildGroupedOpenApi(String group, String path) {
    return GroupedOpenApi.builder()
        .group(group)
        .pathsToMatch("/admin-api/" + path + "/**", "/app-api/" + path + "/**", "/**")
        .addOperationCustomizer((operation, handlerMethod) -> operation
            // .addParametersItem(buildTenantHeaderParameter())
            .addParametersItem(buildSecurityHeaderParameter()))
        .build();
  }

  /**
   * 构建 Authorization 认证请求头参数
   *
   * 解决 Knife4j <a href="https://gitee.com/xiaoym/knife4j/issues/I69QBU">Authorize 未生效，请求header里未包含参数</a>
   *
   * @return 认证参数
   */
  private static Parameter buildSecurityHeaderParameter() {
    return new Parameter()
        .name(HttpHeaders.AUTHORIZATION) // header 名
        .description("认证 Token") // 描述
        .in(String.valueOf(SecurityScheme.In.HEADER)) // 请求 header
        .schema(new StringSchema()._default("Bearer test1").name(HEADER_TENANT_ID).description("认证 Token")); // 默认：使用用户编号为 1
  }

  /**
   * 构建 Tenant 租户编号请求头参数
   * @return 多租户参数
   */
/*   private static Parameter buildTenantHeaderParameter() {
    return new Parameter()
        .name(HEADER_TENANT_ID) // header 名
        .description("租户编号") // 描述
        .in(String.valueOf(SecurityScheme.In.HEADER)) // 请求 header
        .schema(new IntegerSchema()._default(1L).name(HEADER_TENANT_ID).description("租户编号")); // 默认：使用租户编号为 1
  } */
}

package com.ruoyi.common.swagger;

import javax.validation.constraints.NotEmpty;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Swagger 配置属性
 *
 * @author 芋道源码
 */
@ConfigurationProperties("fk.swagger")
@Data
public class SwaggerProperties {

    /**
     * 标题
     */
    @NotEmpty(message = "标题不能为空")
    private String title;
    /**
     * 描述
     */
    @NotEmpty(message = "描述不能为空")
    private String description;
    /**
     * 作者
     */
    @NotEmpty(message = "作者不能为空")
    private String author;
    /**
     * 版本
     */
    @NotEmpty(message = "版本不能为空")
    private String version;
    /**
     * url
     */
    @NotEmpty(message = "扫描的 package 不能为空")
    private String url;
    /**
     * email
     */
    @NotEmpty(message = "扫描的 email 不能为空")
    private String email;

    /**
     * license
     */
    @NotEmpty(message = "扫描的 license 不能为空")
    private String license;

    /**
     * license-url
     */
    @NotEmpty(message = "扫描的 license-url 不能为空")
    private String licenseUrl;

}

3.3在application.yml配置文件添加需要的配置

--- #################### 接口文档配置 ####################

springdoc:
  api-docs:
    enabled: true
    path: /v3/api-docs
  swagger-ui:
    enabled: true
    path: /swagger-ui
  default-flat-param-object: true # 参见 https://doc.xiaominfo.com/docs/faq/v4/knife4j-parameterobject-flat-param 文档

knife4j:
  enable: true
  setting:
    language: zh_cn

fk:
  swagger:
    title: fk开发平台
    description: 提供管理后台、用户 App 的所有功能
    version: ${ruoyi.version}
    url: xxxx
    email: qq.com
    license: xxx
    license-url: xxx

3.4修改SecurityConfig,添加新版文档路径放行

.antMatchers( "/v3/api-docs/*", "/doc.html").permitAll()

4.替换原本的swagger注解

4.1@Api替换@Tag

清理引用

4.2 @ApiOperation替换@Operation

4.3 依次替换

@ApiImplicitParams替换@Parameters

@ApiImplicitParam替换@Parameter

@ApiModel替换@Schema

@ApiModelProperty替换@Schema

最后启动，访问地址即可

标签：Knife4j,String,ruoyi,new,springdoc,org,import,swagger
From： https://www.cnblogs.com/jiutang001/p/18039403

ruoyi的swagger升级Knife4j