使用Springfox在Swagger UI文档中添加头参数

我想在我的休息服务的自动生成的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);
}

如你所见,我已经有了一个体型参数.我只想添加一个头类型.

解决方法:

我刚刚添加了@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 + Header Parameters

标签：swagger-ui,spring,springfox
来源： https://codeday.me/bug/20190722/1502065.html