Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Ознакомьтесь с основными понятиями Центра API Azure, которые позволяют отслеживать API в централизованном расположении для обнаружения, повторного использования и управления.
Модель данных
Основными компонентами в конфигурации Центра API в Azure являются ваши API, а также их версии, определения и развертывания. Возможные среды выполнения для каждого API и описательные метаданные дополняют конфигурацию.
На следующей схеме показаны основные сущности и их связь друг с другом.
API
Логическая сущность верхнего уровня в Центре API Azure представляет любой реальный API, который требуется отслеживать. Центр API может включать API любого типа, включая REST, GraphQL, gRPC, SOAP, WebSocket и Webhook. Вы также можете включить локальные и удаленные серверы MCP и агенты A2A в инвентаризацию центра API.
Вы можете управлять API в инвентаризации любым решением по управлению API. Например, используйте службу управления API Azure, apigee API Management, Kong Konnect, Управление API MuleSoft или другую платформу. API, представленный в Центре API Azure, также может быть неуправляемым.
Руководители программ API или ИТ-администраторы могут создавать инвентаризацию API и управлять ими в Центре API Azure. Центр API Azure также включает функции для разработчиков API для регистрации определений API непосредственно из сред разработки, таких как Visual Studio Code или конвейеры CI/CD.
Версия API
Управление версиями API — это практика управления изменениями в API и обеспечение внесения изменений без нарушения клиентов. API может иметь несколько версий на этапах жизненного цикла, каждая из которых соответствует определенным изменениям API. Некоторые версии могут привести к серьезным или критическим изменениям, а другие добавляют незначительные улучшения. Версия API может находиться на любом этапе жизненного цикла от проектирования до предварительной версии, рабочей среды или устаревшей версии.
Определение API
Для каждой версии API должно быть по крайней мере одно определение, например определение OpenAPI для REST API. Центр API Azure разрешает любой файл определения API, форматированный как текст (YAML, JSON, Markdown и т. д.). Вы можете отправлять определения OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL и WADL, среди прочего.
Чтобы помочь в управлении API, Центр API Azure предоставляет возможности линтинга для анализа определений API, чтобы обеспечить их качество и соответствие стандартам организации.
Окружение
Среда представляет расположение, в котором среда выполнения API развертывается, например служба управления API Azure или служба управления API Apigee. Вы также можете развернуть в вычислительной службе, например, в кластере Kubernetes, веб-приложении или приложении Azure Functions. Каждая среда соответствует определенному этапу жизненного цикла, например разработке, тестированию, промежуточной или промышленной эксплуатации. Среда также может содержать сведения о портале разработчика или интерфейсах управления.
Примечание.
Используйте Центр API Azure для отслеживания любой среды выполнения API независимо от того, размещаются ли они в инфраструктуре Azure. Эти среды не совпадают с средами развертывания Azure.
Развертывание
Развертывание — это расположение (адрес), где пользователи могут получить доступ к API. API может иметь несколько развертываний, таких как различные промежуточные среды или регионы. Например, API может иметь одно развертывание во внутренней промежуточной среде и вторую в рабочей среде. Каждое развертывание связано с определенным определением API.
Метаданные
В Центре API Azure организуйте ваши API, развертывания и другие сущности, задавая значения метаданных. Метаданные полезны для поиска и фильтрации и применения стандартов управления. Центр API предоставляет несколько распространенных встроенных свойств метаданных, таких как API type и lifecycle stage. Владелец центра API может расширить встроенные метаданные, определив пользовательские метаданные в схеме метаданных, чтобы упорядочить свои API, развертывания и среды. Например, создайте API approver свойство метаданных для идентификации человека, ответственного за утверждение API для использования.
Центр API Azure поддерживает пользовательские метаданные массива типов, логическое значение, число, объект, предопределенные варианты и строку.
Схема метаданных Центра API Azure совместима со спецификациями схемы JSON и YAML, чтобы обеспечить проверку схемы в инструментах разработчика и автоматизированных конвейерах.