【问题标题】：Define example input in Swagger for post-request在 Swagger 中为请求后定义示例输入
【发布时间】：2019-03-15 08:01:36
【问题描述】：

我在 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、name 和 phone 的 json 示例。

可以从示例中删除“id”吗？该值由数据库自动递增，并应在调用后作为输入给出..

是否也可以指定示例值？ f.example 例子是

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

【问题讨论】：

我提供的解决方案是否解决了您的疑问？你能达到预期的结果吗？请参阅What should I do when someone answers my question?。作为提问者，您有一项特殊的特权：您可以接受您认为是解决问题的最佳方法的答案。

标签： spring-boot swagger

【解决方案1】：

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

为了隐藏：

@ApiModelProperty(hidden = true)

例如值：

@ApiModelProperty(example = "Sam")

【讨论】：