Используйте Конструктор интеграции, чтобы создать интеграцию API из документа OpenAPI, которую можно сразу использовать в вашем приложении с помощью OneSDK. Опубликуйте интеграцию в общедоступном реестре и загрузите сгенерированный начальный проект.

Вы должны интегрировать новый сервис через API. Надеюсь, у этого API есть документация. Более того, у этого API есть спецификация, например, описание OpenAPI. Каков ваш следующий шаг? Будете мучительно писать код интеграции вручную? Или позволить компьютеру автоматизировать скучные части за вас?

Иметь дело с API-интеграциями не весело, поэтому мы в первую очередь создаем Superface. В то время как вы можете установить готовую интеграцию из каталога, написание пользовательской интеграции раньше было ручным процессом.

Теперь есть еще один вариант: сгенерировать интеграцию с помощью дизайнера интеграции. Этот инструмент берет документ описания OpenAPI для вашего API и создает интеграцию для одной конечной точки API. Вы можете сразу попробовать сгенерированную интеграцию в своем браузере, опубликовать ее в общедоступном реестре и загрузить стартовый проект.

Как это работает

Дизайнер нормализует описание OpenAPI с помощью HTTP Spec library Stoplight. Эта библиотека также обрабатывает документы Swagger и коллекции Postman, которые мы можем поддерживать в будущем.

Как только вы выберете конечную точку, дизайнер разделит интеграцию на три части:

  • Профиль, определение интерфейса, описывающее структуру входных и выходных данных,
  • Карта, описывающая логику интеграции — какие конечные точки использовать, как форматировать данные и как передавать выходные данные,
  • Определение поставщика с указанием URL-адреса базового сервера и схем безопасности, используемых API.

После создания и правильного названия интеграция готова к использованию OneSDK. Демонстрация в браузере выполняет интеграцию с бессерверной функцией с использованием упрощенной версии OneSDK.

Чем он отличается

Существует несколько инструментов для создания SDK из описания OpenAPI, так что же делает конструктор интеграции Superface лучше?

  • Техническое обслуживание. Интеграция Superface строго отделяет определение интерфейса (профиль) от логики интеграции (карта). При таком подходе вы можете поддерживать логику независимо и, при необходимости, менять местами поставщиков, не затрагивая код вашего приложения.
  • Повторное использование. Если вы решите опубликовать интеграцию в общедоступном реестре, вы сможете установить ее в несколько проектов, не занимаясь упаковкой.
  • Эволюция. Кроме того, опубликованную карту можно обновить в реестре. Приложения, использующие OneSDK, могут получать обновленную карту во время выполнения без необходимости повторного развертывания.

Другие преимущества Superface также применимы. Поскольку OneSDK выполняет логику интеграции локально, как часть вашего приложения, вы не ограничены количеством выполнений. Вы можете использовать интеграцию Superface с частными API внутри VPN компании. И между вашим приложением и API нет посредника или прокси-сервера: ваши данные никогда не касаются серверов Superface.

Попробуй сам

Попробуйте конструктор интеграции с вашими документами OpenAPI. Если у вас нет документа под рукой, мы подготовили для вас несколько примеров, или вы можете найти больше документов OpenAPI на APIs.guru.

Это первая общедоступная версия конструктора. Некоторые вещи могут пока не работать должным образом, поэтому мы ждем ваших отзывов! Вы можете сообщать о проблемах непосредственно из конструктора. Кроме того, вы можете связаться с нами в Discord или связаться с нами в частном порядке.

Первоначально опубликовано на https://superface.ai 17 мая 2022 г.