来自注释的 Swagger 示例帖子正文答案

【问题标题】：Swagger Example Post Body From Annotations来自注释的 Swagger 示例帖子正文
【发布时间】：2016-05-17 22:11:28
【问题描述】：

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

以模型对象属性为例：

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

会在 Swagger UI 中产生类似的东西（注意示例 URL 显示在模型架构中）：

【问题讨论】：

你在代码中试过了吗？这正是它的工作原理。输入模型将使用 example 模拟值
@fehguy 是的，我已经尝试了几乎这个确切的代码。它似乎总是将 submit-image-url 的值填充为“字符串”，而不是我在上面的 ApiModelProperty 注释中指定的示例值。

【解决方案1】：

按照它的设计方式，您必须单击数据类型下的示例值才能填充请求/值文本区域（至少在 Swagger 1.5.9 中）。

【讨论】：