swagger-工作

捕風捉影

已于 2023-05-24 17:47:05 修改

阅读量87

点赞数

分类专栏：工作学习文章标签： spring java spring boot

于 2023-05-24 17:46:56 首次发布

本文链接：https://blog.youkuaiyun.com/qq_44833327/article/details/130852253

版权

工作学习专栏收录该内容

17 篇文章

订阅专栏

该文章展示了如何在SpringBoot应用中配置Springfox以生成SwaggerAPI文档，包括启用Swagger，定义API信息，以及设置安全上下文，涉及到Authorization和Authentication的头部token配置。

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

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.24</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.24</version>
        </dependency>
        <dependency>
            <groupId>com.hengtiansoft.sc</groupId>
            <artifactId>common</artifactId>
            <version>2.0.0-SPRING-2.7.3</version>
        </dependency>


# Swagger配置
swagger:
  # 是否启用Swagger文档
  enable: true

SwaggerConfig

package com.hengtiansoft.imonitor.web.config;


import com.hengtiansoft.sc.common.constant.AuthenticationConstants;
import com.hengtiansoft.sc.common.constant.AuthorizationConstants;
import io.swagger.annotations.Api;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Swagger配置
 *
 * @author SC
 * @since 1.0.0
 */
@Configuration
@ConfigurationProperties("swagger")
@ConditionalOnClass(Docket.class)
public class SwaggerConfig {

    @Value("${swagger.enable:true}")
    private boolean enableSwagger;

    @Autowired
    private SwaggerInfo apiInfo;

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(enableSwagger)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());

    }

    private ApiInfo apiInfo() {
        return new ApiInfo(
                apiInfo.getTitle(),
                apiInfo.getDesc(),
                apiInfo.getVersion(),
                null,
                null,
                null, null, Collections.emptyList());
    }

    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey(AuthenticationConstants.TOKEN_HEADER_NAME, AuthenticationConstants.TOKEN_HEADER_NAME, "header"));
        apiKeys.add(new ApiKey(AuthorizationConstants.INFO_HEADER_NAME, AuthorizationConstants.INFO_HEADER_NAME, "header"));
        return apiKeys;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.any())
                .build());
        return securityContexts;
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference(AuthenticationConstants.TOKEN_HEADER_NAME, authorizationScopes));
        securityReferences.add(new SecurityReference(AuthorizationConstants.INFO_HEADER_NAME, authorizationScopes));
        return securityReferences;
    }
}

SwaggerInfo

package com.hengtiansoft.imonitor.web.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

/**
 * Swagger API文档描述
 *
 * @author SC
 * @since 1.0.0
 */
@Data
@Configuration
@ConfigurationProperties("swagger.info")
public class SwaggerInfo {
    /**
     * 标题
     */
    private String title = "恒天Spring Boot标准化示例项目";
    /**
     * 描述
     */
    private String desc = "Spring Boot标准化";
    /**
     * 版本
     */
    private String version = "1.0.2";

}