Разработчики часто тратят много времени на проектирование и создание хорошо сформированных API. Они функционируют так, как рекламируется, соответствуют отраслевым стандартам и внедряются в производство. Но что в этом хорошего, если их использование задокументировано на короткой вики-странице или в текстовом документе, который не поддерживается. Это похоже на то, как производитель автомобилей создает красивый и обтекаемый спортивный автомобиль и никому не позволяет на нем ездить.

Что такое портал разработчиков

Backstage — это гораздо больше, чем просто Портал разработчиков, но давайте начнем и определим, что такое портал разработки и какие преимущества он может принести. Если вы знакомы с пользовательским интерфейсом Swagger, то вы видели базовый портал разработки.

Автоматически создается портал разработки (в данном случае Swagger из аннотаций), настраиваемый веб-сайт, содержащий документацию по вашим API. Сюда входит подпись API, схема, информация об ошибках (например, коды ошибок HTTP) и информация об ответе. Короче говоря, именно здесь потребители вашего API могут найти и узнать о ваших API, а также опробовать их.

Доступно множество платформ порталов разработки, в том числе от ведущих поставщиков API-шлюзов, таких как Axway, IBM или других решений для управления API. Наконец, специальное программное обеспечение для создания комплексного решения для портала разработчиков. В этой статье мы рассмотрим альтернативу с открытым исходным кодом под названием Backstage.

Введение в Backstage

Backstage — это платформа с открытым исходным кодом для создания порталов разработчиков с дополнительными функциями для обнаружения, тестирования и создания программного обеспечения на основе шаблонов.

Эти основные компоненты предоставляются в качестве стандартных компонентов.

  • Каталог программного обеспечения — это центральное место для управления всеми компонентами программного обеспечения в вашей организации. Это не просто API, это могут быть веб-сайты, модели машинного обучения, конвейеры приема и т. д. Каталог построен на основе концепции конструкции метаданных, которая определяет все ваши сервисы.
  • Шаблон программного обеспечения – это определенные шаблоны для запуска новых проектов. Благодаря интеграции с вашей системой контроля версий он создаст репозиторий с новым проектом и автоматически заменит информацию, которую вы вводите для предоставления проекта. Это позволяет быстро строить проекты…