swagger(测试带token的请求){ "code": 401, "msg": "Validate token fail" }

本文介绍如何在SpringBoot项目中整合Swagger,实现RESTful接口的文档自动化生成。通过配置Swagger2Config类,添加全局Header参数,如Authorization令牌,实现接口文档的完善展示。

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

原文链接:https://blog.youkuaiyun.com/ssjq123/article/details/82592022

现在大家一般都是使用SpringBoot写RESTful接口, 但是在测试带有token的请求的时候, 就有点难受了. 传统的PostMan就有点让人炸毛了.  但是现在Swagger出现了.(SpringBoot简直和Swagger是天作之和)

swagger的整合细节就不在这里说了, 下面进入正题:
 

@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
//////////////////////////////////////////////////////////////////////////////
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();  
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("Authorization")
                .description("令牌")
                .modelRef(newModelRef("string"))
                .parameterType("header")
                .required(false).build();
////////////////////////////////////////////////////////////////////////////
        //添加head参数配置end
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cinsc.MainView.ctr"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);//重点看:这里
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("束手就擒--简单优雅的restfun风格")
                .termsOfServiceUrl("https://blog.youkuaiyun.com/ssjq123")
                .version("1.0")
                .build();
    }
}

最终显示效果:Authorization

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值