基于HTTP请求的Swagger @ApiModelProperty灵活性

时间:2018-12-19 22:18:25

标签: java spring-mvc swagger springfox

我在Pojo中的字段上使用Swagger @ApiModelProperty,并使用SpringFox自动生成文档。这是一个示例pojo:

public class Pojo {
 @ApiModelProperty(value =" some id", hidden = true)
 private final String id;
}

我有一个接受Pojo的端点,该端点可以是/ endpoint。该端点同时具有PUT和POST动词。 Swagger Annotation或SpringFox Docket配置是否可以在POST上说从文档隐藏字段“ id”,但在PUT上将字段显示在文档上。

我宁愿不必重复制作Pojo类,也可以注释要隐藏的字段。

1 个答案:

答案 0 :(得分:0)

我不认为这是直接可能的,但是也许您可以通过其他方式解决?这有两种选择:

  1. 进行两个POJO,但一个扩展到另一个id字段。
  2. POSTPUT使用相同的POJO,但以id的形式将PUT字段添加到@PathVariable