Swagger2添加统一header-token

最新推荐文章于 2024-11-15 16:39:35 发布

weixin_30596343

最新推荐文章于 2024-11-15 16:39:35 发布

阅读量629

点赞数

CC 4.0 BY-SA版权

文章标签： python

原文链接：http://www.cnblogs.com/gaomanito/p/10683848.html

本文详细介绍了一种在SpringBoot项目中集成Swagger2的方法，通过配置实现API文档自动生成及接口测试。文章提供了具体代码示例，展示了如何使用@ConditionalOnProperty注解控制Swagger UI的启用，以及如何自定义Docket组件添加全局请求头参数。

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

package com.gx.config;

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.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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


@Configuration
@EnableSwagger2
@ConditionalOnProperty(prefix = "gx.swagger-ui", value = {"enabled"}, havingValue = "true")
public class Swagger2Config {

    private static final String CHITIC_BANK_API_PACKAGE = "com.gx.controller";

    @Bean
    public Docket pdaApi() {
        List<Parameter> parameters = new ArrayList<>();
        parameters.add(new ParameterBuilder()
                .name("token")
                .description("认证token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build());
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("SpringBoot1.0 API")
                .apiInfo(pdaApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(CHITIC_BANK_API_PACKAGE))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo pdaApiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot1.0接口")
                .description("SpringBoot1.0 API接口文档")
                .version("v1.0")
                .build();
    }

}