Swagger之2.0配置_swagger 2.0怎么写-优快云博客

本文链接：https://blog.youkuaiyun.com/netuser1937/article/details/118222457

本文介绍如何在Spring Boot项目中集成并配置Swagger2来生成RESTful API文档，包括全局安全配置、路径选择及注解使用等关键步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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

@Configuration
@EnableSwagger2
@EnableAutoConfiguration
@ConditionalOnProperty(prefix="swagger",value = "enable",havingValue = "true")
public class SwaggerAutoConfiguration
{
    @Bean
    public Docket api() {
//        // Swagger单独配置
//        List<Parameter> pars = new ArrayList<>();
//        ParameterBuilder tokenBuilder = new ParameterBuilder();
//        ParameterBuilder token = tokenBuilder
//                .name("Authorization")
//                .description("用户token，非必传")
//                .modelRef(new ModelRef("string"))
//                .parameterType("header")
//                .required(false);
//        pars.add(token.build());
//        return new Docket(DocumentationType.SWAGGER_2)
//                .globalOperationParameters(pars)
//                .securityContexts(securityContexts())
//                .apiInfo(apiInfo())
//                .select()
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//                .paths(PathSelectors.any())
//                .build();

        // Swagger全局配置
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.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();
    }
}