Центр API Azure — основные понятия
В этой статье описываются основные понятия Центра API Azure. Центр API Azure позволяет отслеживать API в централизованном расположении для обнаружения, повторного использования и управления.
Модель данных
На следующей схеме показаны основные сущности в Центре API Azure и их связь друг с другом. Дополнительные сведения об этих сущностях и связанных понятиях см. в следующих разделах.
API
Логическая сущность верхнего уровня в Центре API Azure представляет любой реальный API, который требуется отслеживать. Центр API может включать API любого типа, включая REST, GraphQL, gRPC, SOAP, WebSocket и Webhook.
API можно управлять любым решением управления API (например, azure Управление API или решениями от других поставщиков) или неуправляемым.
Инвентаризация API в Центре API предназначена для создания и управления с помощью руководителей программ API или ИТ-администраторов.
Версия API
Управление версиями API — это практика управления изменениями в API и обеспечение внесения этих изменений без нарушения клиентов. API может иметь несколько версий на этапах жизненного цикла, каждая из которых соответствует определенным изменениям API. Некоторые версии могут вводить основные или критические изменения, а другие добавляют незначительные улучшения. Версия API может находиться на любом этапе жизненного цикла — от проектирования до предварительной версии, рабочей среды или устаревшей версии.
Определение API
Каждая версия API должна в идеале определяться по крайней мере одним определением, например определением OpenAPI для REST API. Центр API Azure разрешает любой файл определения API, форматированный как текст (YAML, JSON, Markdown и т. д.). Вы можете отправлять определения OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL и WADL, среди прочего.
Среда
Среда представляет расположение, в котором может быть развернута среда выполнения API, например служба Azure Управление API, служба Apigee Управление API или вычислительная служба, например кластер Kubernetes, веб-приложение или функция Azure. Каждая среда соответствует этапу жизненного цикла, например разработке, тестированию, промежуточному или рабочему производству. Среда также может содержать сведения о портале разработчика или интерфейсах управления.
Примечание.
Используйте Центр API Azure для отслеживания любой среды выполнения API, независимо от того, размещаются ли они в инфраструктуре Azure. Эти среды не совпадают с средами развертывания Azure.
Развертывание
Развертывание — это расположение (адрес), где пользователи могут получить доступ к API. API может иметь несколько развертываний, таких как различные промежуточные среды или регионы. Например, API может иметь одно развертывание во внутренней промежуточной среде и вторую в рабочей среде. Каждое развертывание связано с определенным определением API.
Метаданные
В Центре API Azure упорядочение API, развертываний и других сущностей путем задания значений метаданных, которые можно использовать для поиска и фильтрации и применения стандартов управления. Центр API предоставляет несколько распространенных встроенных свойств метаданных, таких как "тип API" и "этап жизненного цикла". Владелец центра API может расширить встроенные метаданные, определив пользовательские метаданные в схеме метаданных, чтобы упорядочить свои API, развертывания и среды. Например, создайте свойство утверждающего API, чтобы определить человека, ответственного за утверждение API для использования.
Центр API Azure поддерживает пользовательские метаданные массива типов, логическое значение, число, объект, предопределенные варианты и строку.
Схема метаданных Центра API Azure совместима со спецификациями схемы JSON и YAML, чтобы обеспечить проверку схемы в инструментах разработчика и автоматизированных конвейерах.