Что такое Центр API Azure?

  • 5 мин

Центр API Azure — это новая служба в Azure, которая предлагает структурированный и централизованный репозиторий всех api организации, обеспечивая унифицированное отслеживание, обнаружение, повторное использование и управление. Центр API — это безопасное решение, которое объединяет и упорядочивает все API независимо от их типа, стадии жизненного цикла разработки или расположения развертывания для среды выполнения API вместе с любыми метаданными или сведениями, связанными с API.

Снимок экрана: целевая страница Центра API Azure в Azure.

Преимущества Центра API

Проблема клиента Преимущества Центра API
Низкая возможность обнаружения и повторного использования API Простота обнаружения и потребления API. Диспетчеры API могут просматривать полный список всех API-интерфейсов в портал Azure. Потребители API могут использовать веб-портал Центра API для обнаружения и использования API, а также расширения Центра API для Visual Studio Code для создания, обнаружения и использования API.
Теневые, неуправляемые API Централизованная инвентаризация API. Центр API позволяет организациям создавать центральный репозиторий API из разных команд и отделов, которые действуют в качестве консолидированного источника истины и доверия для всех API.
Потенциальные угрозы безопасности Простота управления API. С помощью API, объединенных в одном расположении, управление этими API для применения политик безопасности организации становится проще для команд платформы API.
Несогласованный дизайн API Автоматические проверки соответствия api. Центр API позволяет администраторам применять стандарты проектирования во всех API и реализовать рабочий процесс подкладки, который проверяет API в соответствии с определенным руководством по стилю и создает отчет о соответствии API, доступный в Центре API.

Роли экосистемы API и обязанности

Экосистема API организации часто состоит из различных ролей с различными обязанностями, которые являются неотъемлемой частью его успешной работы. Давайте рассмотрим некоторые роли.

  1. Производители API . Это могут быть отдельные разработчики или команды, основные обязанности которых включают:

    • Консолидация спецификаций и требований к системе
    • Проектирование архитектуры API, которая соответствует определенным целям
    • Разработка, защита и публикация API
    • Тестирование и обеспечение соответствия API как функциональным, так и требованиям к производительности
    • Документирование API
    • Операции обслуживания API, в том числе управление версиями и обновлениями

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

  2. Потребители API. Это могут быть внутренние или внешние пользователи API, которые:

    • Использование частных API в своих внутренних рабочих процессах и службах (внутренних потребителей)
    • Использование конечных точек ограниченного API для интеграции в стратегические деловые партнерства (потребители партнеров)
    • Использование общедоступных API для создания внешних систем, использующих службы, предоставляемые организацией (сторонние потребители)

    Потребители API должны убедиться, что они быстро обнаруживают наиболее подходящие API для своих рабочих нагрузок, чтобы избежать использования ценных ресурсов разработки и усилий по дублированию. Чтобы достичь этого, важно, чтобы они получали качество и легко использовать документацию для проверки API, которые решают свои соответствующие потребности, и что они могут легко интегрироваться в свои приложения.

  3. Команда платформы API — инженеры платформы API заботятся о создании и обслуживании масштабируемых, безопасных и высокопроизводительных архитектур API для своей организации. Некоторые из их задач могут включать:

    • Проектирование и разработка архитектуры API
    • Создание и применение рекомендаций ПО API и стандартов проектирования в организации
    • Принудительное применение мониторинга, анализа и отчетов для создания аналитических сведений, доступных для действий
    • Реализация и управление безопасностью API с помощью протоколов проверки подлинности, авторизации и шифрования
    • Упрощение совместной работы и обратной связи между менеджерами продуктов, производителями API и потребителями для согласования с стратегиями API
    • Помощь с интеграцией API и устранение неполадок как внутри, так и во внешнем

Инженеры платформы API в Contoso работают вместе, чтобы развернуть простую стратегию, которая не позволит организации испытывать разрастание API.

Принцип работы Центра API

Инженеры платформы API в организации нуждаются в быстром и простом способе настройки централизованного репозитория всех своих API (как внутренних, так и внешних) вместе с любыми другими метаданными, такими как версии API, определения и многое другое. В Центре API можно создать каталог API, размещенных и управляемых в различных решениях по управлению API, и управлять ими в разных конструкторах, разработке, тестировании и рабочих жизненных циклах.

Снимок экрана: обзор компонентов Центра API

Возможности Центра API Azure

Инвентаризация API

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

С помощью Центра API можно добавлять API-интерфейсы в инвентаризацию независимо от следующего:

  • Технология и язык API: ASP.NET Core Web API, Express, FastAPI, бессерверный API и т. д.
  • Тип API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook и т. д.
  • Среда выполнения: кластер Kubernetes, веб-приложение, Управление API, Apigee Управление API, Функции Azure и т. д.

Управление API

Теперь, с полной инвентаризацией API, мы должны изучить, как мы можем гарантировать, что эти API являются согласованными, стандартизированными, пригодными для использования и безопасными. Управление API определяется как практика определения и применения стандартов, политик и процессов во всех API организации.

Эта возможность в Центре API упрощает отслеживание API с помощью метаданных, таких как версии, владельцы, жизненный цикл и отслеживание таких процессов, как проверки соответствия требованиям, обнаружение критических изменений и т. д.

Центр API также предлагает инструменты по управлению проектированием API, поддерживающим подкладку, реализованную с помощью spectral JSON/YAML linter, которая гарантирует соответствие зарегистрированным API правилам стиля организации и предоставляет функции аналитики для API. Включение этого решения для вашей организации помогает с ранним обнаружением ошибок и несоответствий путем создания отчета о соответствии, который можно просмотреть в Центре API.

Усилия по платформе API наиболее успешны, если у них есть покупка разработчика. Расширение Центра API для Visual Studio Code предоставляет возможности управления API влево с сменой слева для обнаружения критических изменений и управления проектированием API, чтобы обеспечить создание API вправо.

Снимок экрана: анализ API в Центре API

Обнаружение и потребление API

Центр API упрощает весь жизненный цикл разработки API, повышая удобство разработки, интегрируя с популярными средствами разработчиков, такими как Visual Studio Code. Расширение Центра API предоставляет возможность для потребителей API обнаруживать, пытаться и использовать API непосредственно внутри Visual Studio Code в контексте того, как они уже работают. Еще одна возможность Центра API — это традиционный портал центра API, предназначенный для упрощения навигации потребителей API, обнаружения, доступа и использования API из каталога API.

Снимок экрана: веб-портал Центра API

В следующем уроке вы узнаете, как создать инвентаризацию API и управлять ими с помощью Центра API с помощью портал Azure локально с помощью Azure CLI или VS Code с помощью расширения Центра API.