Код IT
← Каталог

Документирование API с использованием Swagger/OpenAPI — Тела запросов и ответы

Фрагмент из «Документирование API с использованием Swagger/OpenAPI»: Тела запросов и ответы.

yaml projectencyclopedia7-08-tehnicheskoe-pismo-3 embed URL статья в энциклопедии
YAML main.yaml 
requestBody:
  required: true
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/User'
      examples:
        user1:
          summary: Пример обычного пользователя
          value:
            id: 5
            username: ivanov_ivan
            email: ivan@example.com
            role: user
requestBody:
  required: true
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/User'
      examples:
        user1:
          summary: Пример обычного пользователя
          value:
            id: 5
            username: ivanov_ivan
            email: ivan@example.com
            role: user