跳至主要內容

SpringBoot3集成Swagger3

sixkey小于 1 分钟后端SpringBootSwagger实战

SpringBoot3集成Swagger3

前言

我们都知道项目接口文档api的重要性,所以这期给大家带来的是SpringBoot3集成Swagger3。开干,我玩的就是真实👶

依赖导入

 <!-- swagger3 调用方式 http://你的主机IP地址:端口号/swagger-ui/index.html -->
      <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.2.0</version>
      </dependency>

swagger配置

package org.cloud.config;

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

/**
 * ClassName: Swagger3Config
 * Package: org.cloud.config
 * Description:
 *
 * @Author: @weixueshi
 * @Create: 2024/4/10 - 21:44
 * @Version: v1.0
 */
@Configuration
public class Swagger3Config
{
    @Bean
    public GroupedOpenApi PayApi()
    {
        return GroupedOpenApi.builder().group("支付微服务模块").pathsToMatch("/pay/**").build();
    }
    @Bean
    public GroupedOpenApi OtherApi()
    {
        return GroupedOpenApi.builder().group("其它微服务模块").pathsToMatch("/other/**", "/others").build();
    }

    @Bean
    public OpenAPI docsOpenApi()
    {
        return new OpenAPI()
                .info(new Info().title("cloud2024")
                        .description("cloud2024")
                        .version("v1.0.0"))
                .externalDocs(new ExternalDocumentation()
                        .description("www.sixkey-world.top")
                        .url("https://www.sixkey-world.top"));
    }
}

效果展示

screenshot-1712757901753
screenshot-1712757901753

是不是很简单,持续关注,分享更多编程技术~