Импортирование API OData

Статья
2025-04-17

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни управления API

В этой статье показано, как импортировать службу, совместимую с OData, в качестве API в Управление API.

В этой статье вы узнаете, как выполнять следующие задачи:

Импорт описания метаданных OData с помощью портал Azure
Управление схемой OData на портале
Защита API OData

Предварительные условия

Инстанция управления API. Если у вас его еще нет, выполните следующее краткое руководство по началу работы: Создать экземпляр Azure API Management.
Служба, предоставленная в виде OData версии 2 или v4.

Перейдите к вашему экземпляру сервиса управления API.

На портале Azure найдите и выберите службы управления API:
На странице управления API выберите ваш экземпляр службы управления API:

Импорт метаданных OData

В меню слева выберите API-интерфейсы> и нажмите кнопку +Добавить API.
В разделе "Создание из определения" выберите OData:
Введите параметры API. Вы можете обновить параметры позже, перейдя на вкладку "Параметры " API.
1. В спецификации OData введите URL-адрес конечной точки метаданных OData. Обычно это значение является URL-адресом корневого каталога службы, добавленным с /$metadata. Кроме того, выберите локальный XML-файл OData для импорта.
2. Введите дополнительные параметры для настройки API. В этом руководстве по импорту и публикации первого API объясняются эти настройки.
Нажмите кнопку создания.

API добавляется в список API. Наборы сущностей и функции, предоставляемые в описании метаданных OData, отображаются на вкладке наборов сущностей и функций API.

Обновление схемы OData

Вы можете получить доступ к редактору на портале для просмотра схемы OData API. При изменении API можно также обновить схему в Управление API из файла или конечной точки службы OData.

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

Тестирование API OData

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

Защита API OData

Защита API OData путем применения существующих политик проверки подлинности и авторизации OData и политики проверки OData для защиты от атак с помощью запросов API OData.

Совет

На портале настройте политики для API OData на вкладке политик API.

Добавление других API

Вы можете создавать API из API, предоставляемых различными службами, в том числе:

Спецификация OpenAPI
A SOAP API
A GraphQL API
Веб-приложение, размещенное в службе приложений Azure
Функции Azure
Приложения логики Azure
Azure Service Fabric

Примечание.

При импорте API операции добавляются к текущему API.

Чтобы добавить API к существующему API, выполните следующие действия.

Перейдите к инстансу службы Управление API Azure на портале Azure.
Выберите API на странице обзора или выберите API> в меню слева.
Выберите многоточие (...) рядом с API, к которому требуется добавить другой API.
Выберите Импорт в раскрывающемся меню:
Выберите службу, из которой следует импортировать API.

Поделиться через