Swagger之OAS 3.0配置

最新推荐文章于 2025-10-25 12:00:33 发布

原创最新推荐文章于 2025-10-25 12:00:33 发布 · 2.7k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#Swagger #OAS 3.0

JAVA 专栏收录该内容

218 篇文章

订阅专栏

本文介绍如何在SpringBoot项目中集成并配置Swagger3来生成API文档，包括全局配置、安全方案配置等关键步骤。

访问地址：http://127.0.0.1:9999/swagger-ui/index.html

import io.swagger.v3.oas.annotations.Operation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.Collections;
import java.util.List;

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        // Swagger全局配置
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                .groupName("music")
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(Operation.class))
                .paths(PathSelectors.any())
                .build();
    }
    // Swagger全局配置--1
    private List<SecurityScheme> securitySchemes() {
        return Collections.singletonList(new ApiKey("Authorization", "Authorization", "header"));
    }
    // Swagger全局配置--2
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(SecurityContext.builder()
                .securityReferences(Collections.singletonList(SecurityReference.builder()
                        .reference("Authorization")
                        .scopes(new AuthorizationScope[]{new AuthorizationScope("global", "用户token")})
                        .build()))
                .build());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 文档")
                .description("Project Api document")
                .version("API V1.0")
                .build();
    }
}