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

Реестр API

Реестр API — сервис для проектирования и управления спецификациями API.

Используя сервис, вы можете:

  • Подготовить спецификацию синхронных/асинхронных API в Code и Low-code редакторах, управлять версиями спецификаций;

    Аналитики могут проектировать спецификации API в удобном редакторе без участия разработчиков.

  • Проверить спецификацию API на ошибки и автоматически исправить их;

    Встроенный валидатор проверяет спецификацию на соответствие стандартам OpenAPI 2.0/3.0, AsynсAPI. Функция сокращает время на проектирование спецификаций, облегчая работу тестировщиков. Проверки можно настроить под стандарты организации.

  • Управлять потребителями API и нагрузкой на программные интерфейсы, получать уведомления об изменениях API;

    В сервисе можно проектировать подключения к API и формировать нагрузку на интеграционное взаимодействие. Это помогает рассчитать лимит подключений к API и уменьшить количество аварий на production средах.

  • Добавлять плагины в спецификацию и управлять ими при проектировании;

    Плагин выступает в роле посредника между API и приложением, т.е. изменяет описанную в спецификации API логику. Тонкая настройка под шлюзы позволяет сократить T2M самой API.

  • Настроить разграничение прав доступа к API и рабочим областям.

    Разграничьте доступ к проектированию и чтению спецификаций для соответствия политикам информационной безопасности.

Возможности Реестра API можно расширить подключив модули:

  • Аудит;
  • Журналирование;
  • Мониторинг;

С помощью Реестр API можно автоматизировать:

  • Публикацию спецификаций и политик потребления на шлюзы;

    Для этого нужно передать спецификации API и информацию о потребителях в Управление API.

  • Подключение внешних клиентов к вашим API.

    Для этого нужно передать каталог API и список потребителей API в Портал OpenAPI.

Следующая схема демонстрирует как устроен сервис Реестр API.

Реестр API

Сервис использует следующий стек технологий:

КомпонентОписание
Astra LinuxОС для виртуальных серверов
PostgreSQLПерсистентное хранилище
KubernetesСистема для управления контейнерами
NGINXРеверсивный прокси
ElasticSearchРаспределённая система поиска и индексации
RedisБуферное хранилище событий аналитики. Содержит бизнес-данные, квоты, счетчики, маркеры доступа
PrometheusСреда мониторинга
AstraОперационная система Openstack