openapi 3.0：如何添加内部有嵌套对象的对象示例？

Question

我想在 openapi 3.0 YAML 中添加响应模式的示例。我已经在链接 https://swagger.io/docs/specification/adding-examples/ 上了解了这个想法，但我的问题是我的响应模式对象内部包含嵌套对象。谁能帮助和指导我如何在嵌套对象时添加示例？

Answer 1

您可以通过两种方式定义响应示例。 让这是您的嵌套 json 对象响应：

{
  "status": true,
  "data": {
    "storeId": "string",
    "message": "string"
  }
}

方法1：在参数定义本身中您可以添加示例

myschema:
  type: object
  properties:
    status:
      type: boolean
      required: true
      example: true
    data:
      type: object
      properties:
        "message":
          type: string
          example: Success
        "Id":
          type: string
          example: 1234

方法2：在属性定义之后，您可以定义一个

example:

标签，如下所示：

myschema:
  type: object
  properties:
    status:
      type: boolean
      required: true
    data:
      type: object
      properties:
        message:
          type: string
        Id:
          type: string
  example: 
    status: true
    data:
      Id: '1234'
      message: success