rest - Swagger/springfox 自动生成响应示例

Question

目前使用 springfox 2.9.2 Swagger 记录在 Spring 中创建的 API。
我想在文档中添加示例响应，就像这张图片一样；



我的理解是我可以做类似的事情:

@ApiResponses(value = {
    @ApiResponse(code = 200, message = "Success", 
            examples = @io.swagger.annotations.Example(
                value = {
                    @ExampleProperty(value = "{'snapshot'：{'type': 'AAA'}}", mediaType = "application/json") 
                }))

我将此代码片段放在 GET 的正上方在这种情况下的方法。
不幸的是，上面的 2 个例子总是显示:标识符预期错误

但我也看到我也可以这样做:

@ApiResponses(value = {
    ApiResponse(code = 200, message = "Success", response = MyModel.class,
    )
})

我也看到我可以用 @ApiOperation 添加一个例子级别:

@ApiOperation(value = "Create a Account", nickname = "createAccount", notes = "Create a account", response = AccountResponse.class, tags={  })

我的问题是:

如何将示例 JSON 响应添加到我的 Swagger 文档中？

最好将 Swagger/Springfox 指向我的模型/bean 并让它自动生成示例响应，并随着 bean/模型的每次更新自动更新。这是上面的第二个代码片段应该做的吗？

Answer 1

定义带有 dto 注释的示例:

@ApiModel("Crop")
public class CropDto {

    @ApiModelProperty(name = "Unique guid", position = 1, example = "7aaee0e2-6884-4fd7-ba63-21d76723dce2")
    public UUID id;
    @ApiModelProperty(name = "Unique code", position = 2, example = "squ")
    public String code;
    @ApiModelProperty(name = "Unique name", position = 3, example = "Squash")
    public String name;
    @ApiModelProperty(position = 4, example = "Cucurbita pepo L.")
    public String description;
}