Hinzufügen eines Header-Parameters in Swagger UI Dokumentation mit Springfox

Question

Ich möchte ein Header-Parameter-Feld in der automatisch generierten Swagger-Dokumentation meines Rest Service hinzufügen. Ich benutze Spring und 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); 
} 

Wie Sie sehen, ich habe bereits einen Körper Typparameter. Ich möchte nur einen Header Typ eins hinzufügen.

Answer 1

Habe ich nur noch @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;)

Sie können auch einen globalen Header auf jeden Dienst in der Dokumentation mit der hier beschriebenen bolution hinzufügen: Spring + Springfox + Header Parameters