如何忽略特定http动词(GET,POST,PUT)的swagger资源属性

时间:2017-02-21 05:12:40

标签: spring spring-mvc swagger-2.0 springfox

我们实现了版本2.6.1的spring fox swagger 2,我想显示HTTP GET METHOD的资源的特定属性而不是POST METHOD,我还没有找到任何使用swagger 2的方法。请帮助谢谢。

例如:

班级员工{

整数id; 字符串名称;

}

请求URI:GET / api / employee / {id} 我应该看到swagger请求文件 {   ID:"&#34 ;,   名:"" }

请求URI:POST / api / employee 我应该看到swagger请求样本为 {     名:"" }

2 个答案:

答案 0 :(得分:1)

我升级到2.8.0版本,可以使用@ApiModelProperty(readOnly = true)。这会导致属性由GET #Returned,而不是在POST / PUT / PATCH

中使用

答案 1 :(得分:0)

这是对大张旗鼓的有效回答。

@ApiModelProperty(readOnly = true)

在Swagger V3中,您需要使用AccesMode。示例:

@Schema(accessMode = Schema.AccessMode.READ_ONLY)
private long id;

这将使ID对所有GET请求可见。