Использование метаданных для управления API
В этой статье содержатся общие сведения о метаданных и его использовании для управления API в Центре API Azure. Вы определяете и задаете метаданные для упорядочивания и фильтрации API и других сущностей в центре API. Метаданные можно создавать или настраивать, а также разрабатывать схему метаданных, чтобы обеспечить согласованность между API, средами и развертываниями.
Встроенные метаданные
При создании или обновлении API, сред и развертываний в центре API необходимо задать определенные встроенные свойства метаданных, такие как тип API (REST, WSDL и т. д.).
В следующих таблицах перечислены встроенные метаданные, предоставляемые для сущностей Центра API Azure. Дополнительные сведения см. в справочнике по REST API Центра API. Таблицы не включают стандартные свойства Azure, такие как идентификаторы ресурсов, заголовки и описания. Не все свойства обязательны.
Программные интерфейсы
| Метаданные | Description | Пример значений |
|---|---|---|
| kind | тип (тип) API | REST, SOAP, GraphQL |
| этап жизненного цикла | этап жизненного цикла разработки API | проектирование, разработка |
| лицензия | сведения о лицензии для API | Идентификатор SPDX, ссылка на текст лицензии |
| внешняя документация | сайт для внешней документации по API | URL-адрес, указывающий на документацию |
| контактные данные | точки контакта для API | адрес электронной почты, имя, URL-адрес |
| условия обслуживания | условия обслуживания для API | URL-адрес, указывающий на условия обслуживания |
Среды
| Метаданные | Description | Пример значений |
|---|---|---|
| kind | тип (тип) среды | рабочая, промежуточная, разработка |
| server | сведения о сервере среды | тип и URL-адрес, указывающий на сервер среды |
| Тип сервера | тип сервера среды | сервер Управление API, сервер Kubernetes, сервер Apigee |
| Подключение | Сведения о подключении для среды | инструкции и URL-адрес, указывающие на портал разработчика среды |
Развертывания
| Метаданные | Description | Пример значений |
|---|---|---|
| server | сведения о сервере развертывания | URL-адрес, указывающий на сервер развертывания |
| state | состояние развертывания | активный, неактивный |
Пользовательские метаданные
Определите пользовательские метаданные с помощью портал Azure, REST API Центра API Azure или Azure CLI для упорядочивания и фильтрации API, сред и развертываний в центре API. Центр API Azure поддерживает пользовательские метаданные следующих типов.
| Тип | Описание | Пример имени |
|---|---|---|
| boolean | true или false | IsInternal |
| number | числовое значение | YearOfCreation |
| строка | текстовое значение | GitHubRepository |
| array | список значений | Теги |
| встроенный выбор | встроенный список вариантов | Department |
| объект | сложный объект, состоящий из нескольких типов | APIApprover |
Внимание
Не включать конфиденциальную, конфиденциальную или личную информацию в заголовки (имена) заданных метаданных. Эти заголовки отображаются в журналах мониторинга, используемых корпорацией Майкрософт для улучшения функциональности службы. Однако другие сведения о метаданных и значениях являются защищенными данными клиента.
Назначение метаданных сущностям
Настраиваемые свойства метаданных можно назначать API, средам или развертываниям в центре API. Например, определите и назначьте метаданные отдела API, чтобы при регистрации API или новой версии API был указан отдел, отвечающий за API.
При назначении сущности метаданные являются необязательными или обязательными. Например, может потребоваться, чтобы метаданные Отдела были заданы только для API, но разрешить YearOfCreation быть необязательными метаданными для сред.
Примечание.
- Определите пользовательские метаданные в любое время и примените к API и другим сущностям в центре API.
- После определения пользовательских метаданных можно изменить назначение на сущность, например от обязательной до необязательной для API.
- Можно изменить значения метаданных, но вы не можете удалить или изменить тип пользовательских метаданных, которые в настоящее время задаются в API, средах и развертываниях. Сначала отмените назначение пользовательских метаданных из сущностей, а затем можно удалить или изменить их.
Использование метаданных для управления
Используйте встроенные и настраиваемые метаданные для упорядочивания API, сред и развертываний в центре API. Например:
Применение стандартов управления в организации путем установки определенных метаданных для API, сред и развертываний.
Поиск и фильтрация API в центре API по значениям метаданных. Вы можете отфильтровать интерфейсы API непосредственно на странице портал Azure или использовать REST API Центра API Azure или Azure CLI для запроса API на основе значений определенных метаданных.
