10.SpringBoot3.x整合springdoc-openapi文档框架

最新推荐文章于 2025-10-26 19:34:22 发布

原创最新推荐文章于 2025-10-26 19:34:22 发布 · 343 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#springboot #springdoc

1.在pom中引入依赖

<!-- 文档api springDoc 配置 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.8</version>
    <exclusions>
        <exclusion>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </exclusion>
    </exclusions>
</dependency>

2.在application.yml文件中配置以下属性

############################################################
# springdoc 配置
############################################################
springdoc:
  api-docs:
    enabled: true #开启OpenApi接口
    path: /v3/api-docs  #定义OpenAPI文档的访问路径，/v3/api-docs
  swagger-ui:
    enabled: true #开启swagger界面，依赖openAPI，需要openApi同时开启
    path: /swagger-ui.html  #定义SwaggerUI的访问路径
    #method:按照HTTP的方法进行排序（如：GET,POST,PUT,DELETE）,alpha:按照操作名称的字母顺序排序
    operations-sorter: method
    tags-sorter: alpha
  default-produces-media-type: application/json
  default-consumes-media-type: application/json
  packages-to-scan: {'com.hp.controller'}

3.创建配置文件

package com.hp.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringDocConfig {

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("xxxx 电商平台接口api")
                        .description("专为xxxx提供的api文档")
                        .version("v1.0")
                        .license(new License().name("Apache 2.0").url("https://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .url("https://springdoc.org")
                        .description("Swagger3 详解"));

    }
}

4.测试

http://localhost:8088/swagger-ui/index.html