在Swagger中定义示例输入以进行后期请求

Question

我在SpringBoot中将DTO用于我的休息服务，

private int id;   
private String name;   
private int phone;
//get and set

在我的控制器类中，我定义了Swagger注释，如下所示：

@ApiOperation(value = "Create a new person", response = personDTO.class)
    @ApiResponses(value = {
            @ApiResponse(code = 201, message = "Successful operation", response = personDTO.class),
            @ApiResponse(code = 400, message = "Server error")})

    @PostMapping("person")
    @ResponseBody
    public ResponseEntity<personDTO> createPerson(@RequestBody personDTO person);

Swagger文档显示了一个示例，该示例基于DTO输入具有 id ，名称和 phone 的json。

是否可以从示例中删除“ id”？该值由数据库自动递增，并应在调用后作为输入提供。

是否还可以指定示例值？ F.example的例子是

{ "name":"Mike", "phone":"12345" }

Answer 1

在DTO中针对该属性使用@ApiModelProperty：

隐藏：

@ApiModelProperty(hidden = true)

例如值：

@ApiModelProperty(example = "Sam")