Как редактировать ответ YAML в пользовательском объекте

Я делаю документацию по 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"}}

Вероятно, в пользовательском объекте.

Отвечает ли это на ваш вопрос -- Swagger: как сделать так, чтобы свойство ссылалось на модель в OpenAPI 2.0 (т. е. вкладывало модели)?

Helen 21.12.2020 09:52

@Helen, спасибо, но ответ ниже - правильный ответ для моего случая

Humayun Naseer 21.12.2020 11:44
Почему в Python есть оператор "pass"?
Почему в Python есть оператор "pass"?
Оператор pass в Python - это простая концепция, которую могут быстро освоить даже новички без опыта программирования.
Коллекции в Laravel более простым способом
Коллекции в Laravel более простым способом
Привет, читатели, сегодня мы узнаем о коллекциях. В Laravel коллекции - это способ манипулировать массивами и играть с массивами данных. Благодаря...
JavaScript Вопросы с множественным выбором и ответы
JavaScript Вопросы с множественным выбором и ответы
Если вы ищете платформу, которая предоставляет вам бесплатный тест JavaScript MCQ (Multiple Choice Questions With Answers) для оценки ваших знаний,...
Массив зависимостей в React
Массив зависимостей в React
Все о массиве Dependency и его связи с useEffect.
1
2
184
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 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 для получения дополнительной информации, а также примечания о том, как использовать ссылки.

Другие вопросы по теме