Добавить API
- Swagger
- Реестр API (обогащённая)
- Реестр API (обогащённая комплексная)
-
Перейдите в раздел Администрирование > Синхронные API.
-
Нажмите кнопку Проверить и импортировать API.
-
Выберите Спецификация в формате Swagger.
-
Нажмите кнопку Выбрать.
-
Загрузите описание API.
Требования:
- Спецификация должна соответствовать стандарту OpenAPI 2.0 или OpenAPI 3.0. Формат файла:
.json
или.yaml
; - Размер файла не более 2 мб.
- Спецификация должна соответствовать стандарту OpenAPI 2.0 или OpenAPI 3.0. Формат файла:
-
Нажмите кнопку Проверить. Система проверит файл и сформирует отчет о проверке. При наличии ошибок в описании API, исправьте их.
-
Нажмите кнопку Перейти к импорту.
-
Укажите версию API. Вы можете импортировать API как новый или добавить загруженную версию к существующему API. При добавлении версии к существующему API можно переопределить адрес целевого сервиса.
-
Нажмите кнопку Далее.
-
Выберите поставщика API. Если его нет в списке, добавьте его.
-
Нажмите кнопку Далее.
-
Укажите адрес сервиса и базовый путь.
-
(необязательно) Подключите балансировщик нагрузки.
-
(необязательно) Уберите базовый путь из URL. Если параметр включен, то шлюз удалит базовый путь из входящего URL, чтобы он не мешал маршрутизации входящего потока.
-
Нажмите кнопку Импортировать.
Далее откроется окно с описанием API. В нем вы можете изменить параметры, настроить логирование или включить API.
-
Перейдите в раздел Администрирование > Синхронные API.
-
Нажмите кнопку Проверить и импортировать API.
-
Выберите Обогащённая спецификация Реестра API.
-
Нажмите кнопку Выбрать.
-
Загрузите описание API.
Требования:
- Спецификация Реестра API должна быть подписана электронной подписью. Формат файла:
.json
; - Размер файла не более 2 мб.
- Спецификация Реестра API должна быть подписана электронной подписью. Формат файла:
-
Нажмите кнопку Импортировать. Система проверит файл и электронную подпись. При наличии ошибок в описании API, исправьте их.
Далее откр оется окно с описанием API. В нем вы можете изменить параметры, настроить логирование или включить API.
-
Перейдите в раздел Администрирование > Синхронные API.
-
Нажмите кнопку Проверить и импортировать API.
-
Выберите Обогащённая комплексная спецификация Реестра API для публикации на несколько шлюзов сразу.
-
Нажмите кнопку Выбрать.
-
Загрузите описание API.
Требования:
- Спецификация Реестра API должна быть подписана электронной подписью. Формат файла:
.json
; - Размер файла не более 2 мб.
- Спецификация Реестра API должна быть подписана электронной подписью. Формат файла:
-
Нажмите кнопку Импортировать. Система проверит файл и электронную подпись. При наличии ошибок в описании API, ис правьте их.
Далее откроется окно со списком шлюзов (организаций), куда были опубликованы API.
По умолчанию API не активен.