Swagger Header单个接口及其全局接口添加

1.单个接口header设置

直接使用swagger的注解ApiImplicitParam , 如下
    @ApiOperation(value = "用户",notes = "测试用户枚举")
    @ApiImplicitParam(name = "app_token", value = "app_token",required = true, dataType = "String",paramType="header")
    @RequestMapping(value = "/test6" , method = RequestMethod.POST)
    public String test6(HttpServletRequest request,@RequestBody User1 user) {
        String app_token = request.getHeader("app_token");
        System.out.println(user+"+"+app_token);
        return user.getName();
    }

效果如下:


WX20190617-152112.png

同样的可以直接使用注解@RequestHeader代替

    @ApiOperation(value = "用户",notes = "测试")
    @RequestMapping(value = "/test7" , method = RequestMethod.POST)
    public String test7(@RequestBody User1 user, @RequestHeader(required = false) String app_token) {
        System.out.println(user+"+"+app_token);
        return user.getName();
    }

2.全局接口header设置

在swagger中添加全局header配置 , 如下

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(true).build();

        List<Parameter> aParameters = Lists.newArrayList();
        aParameters.add(aParameterBuilder.build());
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .globalOperationParameters(aParameters)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo1.controller"))
                .paths(PathSelectors.any()).build();
    }
}

效果图


WX20190617-151844.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 今天技术总监说:小明,我们本次3.0改造,使用swagger2.0作为前后端分离的接口规范,它可以一键生成前后端的...
    coder小明阅读 3,428评论 4 12
  • 一、简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题...
    Java中文社群_老王阅读 3,180评论 0 50
  • 桃符换了,春联贴了,转眼之间,又是一年!去年贴的福字还在眼前,去年年夜饭的香味还在舌尖,去年辞旧岁的鞭炮声还在耳边...
    倾心听雨1阅读 414评论 0 2
  • 今天我在学校里和一位同学换了座位,我被换到了李泽帅的旁边。李泽帅欢迎我过来,我也欢迎他成为我的新同桌。然后我们去上...
    杨小鱼儿0728阅读 123评论 0 1
  • 研二专硕以及研三学硕毕业的同学论文的盲审结果出来了,非常紧张的一个环节,我们导师组的一个师兄的审核结果是两个不推荐...
    吴三石石石石ah阅读 97评论 0 0