Добавить параметр заголовка в документации Swagger UI с помощью Springfox

Question

Я хочу добавить поле параметра заголовка в автогенерированную документацию для моего сервиса отдыха. Я использую Spring и 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); 
} 

Как вы видите, я уже тела параметр в типа. Я просто хочу добавить заголовок типа один.

Answer 1

Я просто добавил @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;)

Вы можете также добавить глобальный заголовок на каждой службе в документации с bolution описанной здесь: Spring + Springfox + Header Parameters