使用Springfox在Swagger UI文檔中添加標題參數

Question

我想在我的休息服務的自動生成的swagger ui文檔中添加標題參數字段。我使用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