如何在用户对象中编辑 YAML 响应

Question

我正在大摇大摆地制作 API 文档 在我的 swagger 编辑器中，我将返回此响应

 {
  "id": "70020ed1-50fe-4c7e-afed",
  "email": "test123@gmail.com",
  "authentication_token": "xzmsjvvkvgf448449"
}

通过 swagger 编辑器中的以下代码

responses:
        200:
          description: User credentials.
          schema:
          # $ref: '#/definitions/User'
            properties:
              id:
                type: string
                example: 70020ed1-50fe-4c7e-afed
              email:
                type: string
                example: test123@gmail.com
              authentication_token:
                type: string
                example: xzmsjvvkvgf448449

我想以实际的方式展示它。像这样

    {
    "message": "User Information & already exist",
    "user": {
        "id": "2386d9c5-5530-4950-b8fe-",
        "email": "saad.arshad@yahoo.com",
        "authentication_token": "kagHmoRSmPiu2R"}}

可能在用户对象中。

Answer 1

您需要将 user 嵌套在一个对象中：

responses:
  200:
    description: User credentials.
    content:
      application/json:
        schema:
          properties:
            message:
              type: string
              example: "User Information already exists"
            user:
              type: object
              properties:
                id:
                  type: string
                  example: 70020ed1-50fe-4c7e-afed
                email:
                  type: string
                  example: test123@gmail.com
                authentication_token:
                  type: string
                  example: xzmsjvvkvgf448449

请参阅 https://swagger.io/docs/specification/data-models/data-types/#nested 了解更多信息，以及有关如何使用引用的注释。