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

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

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

yaml projectencyclopedia7-08-tehnicheskoe-pismo-3 embed URL статья в энциклопедии
YAML main.yaml 
parameters:
  - name: page
    in: query
    description: Номер страницы результатов
    required: false
    schema:
      type: integer
      minimum: 1
      default: 1
  - name: sort
    in: query
    description: Поле для сортировки
    required: false
    schema:
      type: string
      enum: [created_at, updated_at, title]
      default: created_at
parameters:
  - name: page
    in: query
    description: Номер страницы результатов
    required: false
    schema:
      type: integer
      minimum: 1
      default: 1
  - name: sort
    in: query
    description: Поле для сортировки
    required: false
    schema:
      type: string
      enum: [created_at, updated_at, title]
      default: created_at