Импорт API OData

  • Статья

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

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

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

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

Примечание.

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

Необходимые компоненты

  • Экземпляр управления API. Если у вас еще нет одного, выполните следующее краткое руководство. Создайте экземпляр Azure Управление API.

  • Служба, предоставленная как OData версии 2 или v4.

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

  1. На портале Azure найдите и выберите службы Управление API.

    Выбор

  2. На странице Службы Управления API выберите экземпляр Управления API.

    Выбор экземпляра службы

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

  1. В меню слева выберите API>+ Добавить API.

  2. В разделе "Создание из определения" выберите OData.

    Снимок экрана: создание API из описания OData на портале.

  3. Введите параметры API. Вы можете обновить параметры позже, перейдя на вкладку Параметры API.

    1. В спецификации OData введите URL-адрес конечной точки метаданных OData, как правило, URL-адрес корня службы, добавленный с /$metadata. Кроме того, выберите локальный XML-файл OData для импорта.

    2. Введите оставшиеся параметры для настройки API. Эти параметры описаны в руководстве по импорту и публикации первого руководства по API .

  4. Нажмите кнопку создания.

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

    Снимок экрана: наборы сущностей и функции OData на портале.

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

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

  1. На портале, перейдите к вашему экземпляру службы "Управление API".

  2. В меню слева выберите API-интерфейсы> API OData.

  3. На вкладке "Наборы сущностей" и "Функции " выберите контекстное меню (...) рядом с набором сущностей или функцией и нажмите кнопку "Изменить".

    Снимок экрана: контекстное меню для объекта OData, заданного на портале.

  4. Просмотрите схему. Если вы хотите обновить его, выберите "Обновить из файла " или "Обновить схему" из конечной точки.

    Снимок экрана: редактор схемы для API OData на портале.

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

  1. В меню слева выберите API-интерфейсы> API OData.

  2. На вкладке наборов сущностей и функций выберите контекстное меню (...) рядом с набором сущностей или функцией и выберите " Тест".

    Снимок экрана: параметр

  3. В консоли тестирования введите параметры шаблона, параметры запроса и заголовки для теста и выберите "Тест". Дополнительные сведения о тестировании API на портале.

Защита API OData

Защита API 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.

  1. Перейдите в свой экземпляр службы "Управление API" на портале Azure.

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

  2. Выберите API на странице Обзор или в меню слева.

    Выберите API

  3. Щелкните ...рядом с API, к которому нужно добавить другой API.

  4. В раскрывающемся меню выберите Импорт.

    Выберите импорт

  5. Выберите службу, из которой следует импортировать API.

    Выбор службы