小编Jon*_*uet的帖子

昂首阔步:用ref添加描述

我想向引用其定义的对象属性添加描述。像这样:

      newCreditCard:
        type: object
        properties:
          billingPhone:
            description: Phone number of the card holder
            $ref: "#/definitions/PhoneNumber"
Run Code Online (Sandbox Code Playgroud)

但是编辑器警告说description属性将被跳过:

Extra JSON Reference properties will be ignored: description
Run Code Online (Sandbox Code Playgroud)

我发现了一种不太优雅的解决方法,该方法适用于编辑器,但不适用于Swagger UI(不确定这可能是由于Swagger UI的3.0.2版本最近进行了更新)

      newCreditCard:
        type: object
        properties:
          billingPhone:
            description: Phone number of the card holder
            allOf:
            - $ref: "#/definitions/PhoneNumber"
Run Code Online (Sandbox Code Playgroud)

您如何在Swaggers规范中做到这一点?

谢谢您的帮助!

swagger swagger-ui swagger-editor

9
推荐指数
1
解决办法
3122
查看次数

标签 统计

swagger ×1

swagger-editor ×1

swagger-ui ×1