记：Springboot3+Springdoc集成swagger3(open api 3)

引入依赖

<!-- springdoc  用于集成swagger3-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.5.0</version>
</dependency>

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
    <version>2.5.0</version>
</dependency>

<!--  配置注释处理器 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

配置代码(swagger3配置类)

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import top.clownz.service_base.common.constant.ContactConstant;

/**
 * @Desc: swagger3 配置(结合Springdoc)
 */
@Configuration
public class Swagger3SpringDocConfig {

    private final SwaggerProperties swaggerProperties;

    public Swagger3SpringDocConfig(SwaggerProperties swaggerProperties) {
        this.swaggerProperties = swaggerProperties;
    }
    
        /**
     * 配置并创建OpenAPI实例，用于展示和定义API的信息。
     *
     * @return OpenAPI对象，包含了API的元数据、外部文档链接等。
     */
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                // 设置OpenAPI的元数据
                .info(webApiInfo())
                // 配置外部文档链接
                .externalDocs(new ExternalDocumentation()
                        .description(swaggerProperties.getApplicationDescription())
                        .url("/"))
                ;
    }
    


    /**
     * 构建API信息对象
     *
     * @return 返回一个配置好的ApiInfo实例，包含API的标题、描述、版本以及联系方式等信息
     */
    private Info webApiInfo() {
        // 使用ApiInfoBuilder构建ApiInfo实例
        return new Info()
                // API文档标题 // "网站-课程中心API文档(swagger3)"
                .title(swaggerProperties.getApplicationName())
                // API文档描述
                .description(swaggerProperties.getApplicationDescription())
                // API版本
                .version(swaggerProperties.getApplicationVersion())
                // API作者及联系方式
                .contact(contactInfo());
    }


    /**
     * 构建并返回一个联系人信息对象。
     * 该方法不需要任何参数，它会创建一个具有预定义属性的Contact对象。
     *
     * @return Contact 返回一个配置好的Contact对象，包含名称、网址和电子邮件地址。
     */
    private Contact contactInfo() {
        // 创建并初始化Contact对象，设置其名称、网址和电子邮件
        return new Contact()
                .name(ContactConstant.CONTACT_NAME)
                .url(ContactConstant.CONTACT_URL)
                .email(ContactConstant.CONTACT_EMAIL);
    }

}

swagger属性配置

1.SwaggerProperties属性配置类

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author: Clown
 * @Desc: 自定义swagger配置类SwaggerProperties
 */
@Component
@ConfigurationProperties("swagger")
@Data
public class SwaggerProperties {
    
    /**
     * 是否开启swagger，生产环境一般关闭，所以这里定义一个变量
     */
    private Boolean enable;
    /**
     * 项目应用名
     */
    private String applicationName;
    /**
     * 项目版本信息
     */
    private String applicationVersion;
    /**
     * 项目描述信息
     */
    private String applicationDescription;
    /**
     * 接口调试地址
     */
    private String tryHost;
}

2.yml配置

# ===== 自定义swagger配置 ===== #
swagger:
  enable: true
  application-name: ${spring.application.name}
  application-version: 1.0
  application-description: springfox swagger 3.0整合Demo
  try-host: http://localhost:${server.port}

问题

出现 response status is 500 /v3/api-docs

springfox:
  documentation:
    open-api:
      v3:
        # 解决response status is 500 /v3/api-docs）
        path: ${spring.application.name}/v3/api-docs