【问题标题】:Swagger ApiModelProperty accessSwagger ApiModel 属性访问
【发布时间】:2015-12-05 17:55:17
【问题描述】:

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

【问题讨论】:

    标签: java spring-mvc swagger-2.0


    【解决方案1】:

    我觉得你可以试试

    @ApiParam(access = "hidden")
    

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

    【讨论】:

      【解决方案2】:

      现在可以使用了

      @ApiModelProperty(hidden=true)
      

      【讨论】:

        【解决方案3】:

        你也可以试试:

        @Schema(accessMode=AccessMode.READ_ONLY)
        

        【讨论】:

          【解决方案4】:

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

          @ApiModelProperty(readOnly = true)
          
          

          【讨论】:

          • 不幸的是,这在 swagger 1.6 上不起作用,当此注释应用于 java 字段时,该属性同时显示在请求和响应中。
          【解决方案5】:

          你最好为此编写一个新的 DTO

          【讨论】:

            猜你喜欢
            • 1970-01-01
            • 1970-01-01
            • 1970-01-01
            • 2015-02-21
            • 2015-11-03
            • 2017-03-16
            • 2013-12-23
            • 2013-07-11
            • 2011-07-12
            相关资源
            最近更新 更多