ID不应显示在带有Swagger+Spring的模型模式中

Question

我将Swagger2与Springfox和SpringBoot一起使用。我有一个这样定义的端点：

@ApiOperation(value = "save", nickname = "Save Store")
@ApiResponses(value = {
        @ApiResponse(code = 201, message = "Created"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 500, message = "Failure", response = ErrorResource.class)})
@RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.CREATED)
public void save(@Valid @RequestBody Store store, BindingResult bindingResult, HttpServletRequest request, HttpServletResponse response) {
    if (bindingResult.hasErrors()) {
        throw new InvalidRequestException("Invalid Store", bindingResult);
    }
    this.storeService.save(store);
    response.setHeader("Location", request.getRequestURL().append("/").append(store.getId()).toString());
}

生成的API文档显示了模型模式中Store的id。从技术上讲，在创建Store时，JSON不应包含id。我想知道如何告诉Swagger/Springfox忽略id，但只针对这个端点。

Answer 1

您可以通过用@ApiModelProperty注释类的属性并将其hidden属性设置为true来隐藏模型中的字段。

import io.swagger.annotations.ApiModelProperty;
public class Store {
    @ApiModelProperty(hidden = true)
    private Long id;
}

不幸的是，这样做会隐藏每个使用Store类作为输入的端点上的id字段。显示另一个端点的字段需要一个单独的类。