Перейти к основному содержимому

Добавить API

  1. Перейдите в раздел Администрирование > Синхронные API.

  2. Нажмите кнопку Проверить и импортировать API.

  3. Выберите Спецификация в формате Swagger.

  4. Нажмите кнопку Выбрать.

  5. Загрузите описание API.

    Требования:

    • Спецификация должна соответствовать стандарту OpenAPI 2.0 или OpenAPI 3.0. Формат файла: .json или .yaml;
    • Размер файла не более 2 мб.
  6. Нажмите кнопку Проверить. Система проверит файл и сформирует отчет о проверке. При наличии ошибок в описании API, исправьте их.

  7. Нажмите кнопку Перейти к импорту.

  8. Укажите версию API. Вы можете импортировать API как новый или добавить загруженную версию к существующему API. При добавлении версии к существующему API можно переопределить адрес целевого сервиса.

  9. Нажмите кнопку Далее.

  10. Выберите поставщика API. Если его нет в списке, добавьте его.

  11. Нажмите кнопку Далее.

  12. Укажите адрес сервиса и базовый путь.

  13. (необязательно) Подключите балансировщик нагрузки.

  14. (необязательно) Уберите базовый путь из URL. Если параметр включен, то шлюз удалит базовый путь из входящего URL, чтобы он не мешал маршрутизации входящего потока.

  15. Нажмите кнопку Импортировать.

Далее откроется окно с описанием API. В нем вы можете изменить параметры, настроить логирование или включить API.

По умолчанию API не активен.