关于sprintboot3版本以上中的swagger3.0的使用

时间：2024-05-31 14:06:30

文章目录

      • 1.配置pom.xml(添加以下内容，记住点一下右上方maven下载)
      • 2.application.properties添加以下配置信息
      • 3.新建swagger的config配置信息，文件位置如下
      • 4.添加接口注释信息
      • 访问swagger文档

1.配置pom.xml(添加以下内容，记住点一下右上方maven下载)

在这里插入图片描述
供代码复制

<dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.0.2</version>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-api</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>

2.application.properties添加以下配置信息

在这里插入图片描述
供代码复制

# 启用 Springdoc 自动生成 API 文档
springdoc.api-docs.enabled=true
# 配置生成的 API 文档的访问路径，默认为 "/v3/api-docs"
springdoc.api-docs.path=/v3/api-docs
# 配置 Swagger-UI 的访问路径，默认为 "/swagger-ui.html"
springdoc.swagger-ui.path=/swagger-ui.html

3.新建swagger的config配置信息，文件位置如下

在这里插入图片描述
供代码复制

package org.example.helloworld.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 SwaggerConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("标题")
                        .description("我的API文档")
                        .version("v1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文档")
                        .url("https://springshop.wiki.github.org/docs"));
    }

}

4.添加接口注释信息

在这里插入图片描述
在get,post等注解上添加注释信息，后面生成的swagger文档对应接口会带有注释

访问swagger文档

启动项目后，浏览器输入地址：http://localhost:8080/swagger-ui/index.html#/
在这里插入图片描述
注释正常显示，文档访问成功

相关文章