Swagger示例帖子正文从注释

时间:2016-05-17 22:11:29

标签: java annotations swagger swagger-ui

有没有人知道是否可以使用Java注释中的预填充/默认值创建示例帖子正文?我的目标是让用户在Swagger UI中查看POST端点时有一个工作示例。理想情况下,此工作示例是从代码中的注释创建的。

有关模型对象属性的示例:

    @ApiModelProperty(example = "http://istock.com/my_cool_image")
    @JsonProperty("submitted-image-url")
    private String submittedImageUrl;

会在Swagger UI中产生类似的内容(请注意示例网址显示在模型架构中):

enter image description here

1 个答案:

答案 0 :(得分:1)

它的设计方式,您必须单击数据类型下的示例值才能填充请求/值textarea(至少在Swagger 1.5.9中)。