Swagger ApiModelProperty access

2022-09-01 17:53:39

我在 REST 终结点上对我的请求和响应使用相同的对象。是否可以使用 ApiModelProperty(access = “response”) 对属性进行注释,然后使用 @ApiImplicitParam(access = “response”) 对 rest 终结点方法进行注释,以便该属性仅显示在响应对象的 swagger 文档中,而不是请求文档中?


答案 1

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

@ApiModelProperty(readOnly = true)


答案 2

我想你可以试试

@ApiParam(access = "hidden")

参考:
带有 Swagger 的 Spring Rest API – 微调公开的文档


推荐