对象的 ApiModelProperty 注释不能使用 swagger

Question

swagger 版本 1.5.20

 public class SomeDto extends TemporallyScopedEntityDto {

    @ApiModelProperty(value="This DOES NOT display in swagger ui docs")
    private ZonedDateTimeDto publishDate;

    @ApiModelProperty(value="This DOES display in swagger ui docs")
    private List<CodeTypeDto> territories = new ArrayList<>();
}

两个注释都出现在 api-docs json 文件中

但是发布日期没有出现在 swagger 文档 UI 中

领土确实出现在 swagger 文档 UI 中

java对象不能这样注解有什么原因吗

Answer 1

不幸的是，Swagger 并不真正支持向嵌套字段添加描述。 请参阅此link 的最后一部分以获取有关它的一些背景信息。