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

【问题标题】：Swagger @ApiModelProperty flexibility based on HTTP RequestSwagger @ApiModelProperty 基于 HTTP 请求的灵活性
【发布时间】：2019-05-20 11:00:25
【问题描述】：

我在 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 类，这样我就可以注释要隐藏的字段。

【问题讨论】：

我很欣赏这个问题，我很惊讶地看到这可能是不可能的......

标签： java spring-mvc swagger springfox

【解决方案1】：

我不相信这是直接可能的，但也许你可以通过其他方式解决它？这里有几个选择：

创建两个 POJO，但其中一个使用 id-field 扩展另一个。
对POST 和PUT 使用相同的POJO，但以@PathVariable 的形式将id 字段添加到PUT。

【讨论】：

感谢您的建议！我认为只做两条 POJO 路线可能是最好的选择。