使用Springfox在Swagger UI文档中添加标头参数 [英] Add a header parameter in Swagger UI documentation with Springfox

问题描述

我想在我的rest服务的自动生成的swagger ui文档中添加标头参数字段.我使用Spring和Springfox.

I want to add a header parameter field in the auto-generated swagger ui documentation of my rest service. I use Spring and Springfox.

public ResponseEntity<User> saveNewUser(
        @ApiParam(value = "the user to create", required = true) @RequestBody User user) throws RestServiceException {

    userService.save(user);
    return new ResponseEntity<User>(user, HttpStatus.OK);
}

如您所见，我已经有一个 body 类型参数.我只想添加一个标题类型.

As you see I have already a body type parameter. I just want to add a header type one.

推荐答案

我刚刚添加了@RequestHeader(value="myHeader") String headerStr:

public ResponseEntity<User> saveNewUser(
        @RequestHeader(value="myHeader") String headerStr,
        @ApiParam(value = "the user to create", required = true) @RequestBody User user) throws RestServiceException {

    userService.save(user);
    return new ResponseEntity<User>(user, HttpStatus.OK);
}

(import org.springframework.web.bind.annotation.RequestHeader;)

您还可以使用此处描述的解决方案在文档中的每个服务上添加全局标头: Spring + Springfox +标头参数

You can also add a global header on every service in your documentation with the solution described here : Spring + Springfox + Header Parameters

这篇关于使用Springfox在Swagger UI文档中添加标头参数的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！