微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何在特定路径中隐藏 swagger ref 属性?

如何解决如何在特定路径中隐藏 swagger ref 属性?

我在 swagger 文档中有这个结构:

  FunctionTitle:
    type: object
    required:
    - funcId
    - czechName
    - priority
    properties:
      funcId:
        type: number
        format: id
        example: 1226
      czechName:
        type: string
        example: Guvernér
      priority:
        type: number
        example: 21
      org:
        $ref: '#/deFinitions/Organ'
      funcType:
        $ref: '#/deFinitions/FunctionType' 

在某些路径中,我想返回此结构,但没有属性 org 和 funcType。所以我的回答应该是这样的:

{
"funcId" : 1226,"czechName" : "Guvernér",priority: 21
}

我没有找到如何选择不返回属性 org 和 funcType。我知道我可以为它创建另一个模型,但是我最好只根据需要隐藏属性而不是创建另一个模型。这是我的路径示例:

  /periods:
    get:
      tags:
      - developers & users
      summary: Periods
      operationId: periods
      description: |
        By passing in the appropriate options,you can search for
        available inventory in the system
      produces:
      - application/json
      responses:
        200:
          description: search  matching criteria
          schema:
            type: object
            properties:
              periods:
                type: array
                items:
                  $ref: '#/deFinitions/FunctionTitle'
        400:
          description: bad input parameter

感谢您的回答!

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。