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

最新推荐文章于 2025-05-13 17:54:22 发布

_K_先生

最新推荐文章于 2025-05-13 17:54:22 发布

阅读量1.2w

点赞数

CC 4.0 BY-SA版权

分类专栏：小坑

本文链接：https://blog.youkuaiyun.com/zhangxiaojun211/article/details/101098988

小坑专栏收录该内容

15 篇文章

订阅专栏

本文介绍如何在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