Swagger ApiModelProperty访问

时间:2015-09-09 16:39:20

标签: java spring-mvc swagger-2.0

我在休息端点上为我的请求和响应使用相同的对象。 是否可以使用ApiModelProperty注释属性(access =" response") 然后用@ApiImplicitParam注释其余的端点方法(access =" response") 所以该属性只显示在响应对象的swagger文档而不是请求对象?

5 个答案:

答案 0 :(得分:1)

您可以使用@ApiModelProperty(readOnly = true).实现相同的目标 允许将模型属性指定为只读。它将隐藏请求中的属性,并仅显示响应。

@ApiModelProperty(readOnly = true)

答案 1 :(得分:0)

我认为你可以试试

@ApiParam(access = "hidden")

参考:
Spring Rest API with Swagger – Fine-tuning exposed documentation

答案 2 :(得分:0)

您现在可以使用

@ApiModelProperty(hidden=true)

答案 3 :(得分:0)

您也可以尝试:

@Schema(accessMode=AccessMode.READ_ONLY)

答案 4 :(得分:0)

为此,您最好编写一个新的DTO