Импорт метаданных SAP OData в качестве API

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

В этой статье показано, как импортировать службу OData, используя ее описание метаданных. В этой статье sap Gateway Foundation служит примером.

Работая с этой статьей, вы узнаете о следующем.

• Получение метаданных OData из службы SAP
• Импорт метаданных OData в Управление API напрямую или после преобразования в спецификацию OpenAPI
• Настройка API
• проверка API на портале Azure;

Примечание.

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

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

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

• Система и служба SAP, предоставляемые как OData версии 2 или 4.

• Если серверная часть SAP использует самозаверяющий сертификат (для тестирования), возможно, потребуется отключить проверку цепочки доверия для SSL. Для этого настройте серверную часть в экземпляре Управления API:

  1. На портале Azure в разделе API выберите Серверные компоненты>+ Добавить.
  2. Добавьте настраиваемый URL-адрес, указывающий на серверную службу SAP.
  3. Снимите флажки Validate certificate chain (Проверка цепочки сертификатов) и Validate certificate name (Проверка имени сертификата).

  Примечание.

  В рабочих сценариях используйте правильные сертификаты для полной проверки SSL.

Получение метаданных OData из службы SAP

Получение XML метаданных из службы SAP с помощью одного из следующих методов. Если вы планируете преобразовать XML-файл метаданных в спецификацию OpenAPI, сохраните файл локально.

• Используйте клиент SAP Gateway (транзакция /IWFND/GW_CLIENT);
• Выполните прямой HTTP-вызов для получения XML: http://<OData server URL>:<port>/<path>/$metadata

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

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

   

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

   

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

Выберите один из следующих методов для импорта API в Управление API: импортируйте XML метаданных как API OData напрямую или преобразуйте XML метаданных в спецификацию OpenAPI.

Метаданные OData

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

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

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

   

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

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

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

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

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

   

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

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

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

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

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

   

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

   

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

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

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

   

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

Защита API OData

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

Совет

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

Спецификация OpenAPI

Преобразование метаданных OData в JSON OpenAPI

1. Преобразуйте XML-файл OData в формат JSON OpenAPI. Используйте средство OASIS с открытым кодом для OData версии 2 или OData версии 4 в зависимости от XML-файла метаданных.

   Ниже приведен пример команды для преобразования XML-файла OData версии 2 для тестовой службы epm_ref_apps_prod_man_srv:

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Примечание.

   • Для тестирования с одним XML-файлом можно использовать веб-версию преобразователя на основе средства с открытым кодом.
   • При использовании средства или веб-версии преобразователя указывать <IP-адрес>:<порт> сервера SAP OData необязательно. Кроме того, вы можете добавить эти сведения позже в созданную спецификацию OpenAPI или после импорта в Управление API.

2. Сохраните файл openapi-spec.json локально для импорта в Управление API.

Импорт и публикация API серверной части

1. В меню навигации сбоку выберите API в разделе API.

2. В разделе Create a new definition (Создание нового определения) выберите Спецификация OpenAPI.

   

3. Щелкните Выбрать файл и выберите файл openapi-spec.json, сохраненный локально на предыдущем шаге.

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

   • В поле Суффикс URL-адреса API рекомендуется использовать тот же путь URL-адреса, что и в исходной службе SAP.

   • Дополнительные сведения о настройках API-интерфейсов см. в обучающей статье Импорт и публикация первого API.

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

Примечание.

См. подробнее об ограничении импорта API.

Настройка API

Добавьте приведенные ниже три операции в импортированный API.

• GET /$metadata

  Операция	Description	Дальнейшая настройка для операции
  GET /$metadata	Позволяет службе "Управление API" обращаться к конечной точке $metadata, которая требуется для интеграции клиента с сервером OData. Эта обязательная операция не включена в спецификацию OpenAPI, которую вы создали и импортировали.	Добавьте ответ 200 OK.

  

• HEAD /

  Операция	Description	Дальнейшая настройка для операции
  HEAD /	Позволяет клиенту при необходимости обмениваться токенами для защиты от подделки межсайтовых запросов (CSRF) с сервером SAP. SAP также разрешает выполнять обмен токенами CSRF с помощью команды GET. Обмен токенами CSRF не рассматривается в этой статье. Обмен маркерами брокера см. в примере фрагмента политики Управления API.	Н/П

  

• GET /

  Операция	Description	Дальнейшая настройка для операции
  GET /	Позволяет настроить конфигурацию политики в корневом каталоге службы.	Настройте следующую политику rewrite-uri для входящего трафика, чтобы добавлять косую черту в конец запросов, которые перенаправляются в корневой каталог службы: <rewrite-uri template="/" copy-unmatched-params="true" /> Эта политика устраняет возможную неоднозначность в запросах с косыми чертами в конце или без них, которые по-разному обрабатываются некоторыми внутренними серверами.

  

Кроме того, настройте проверку подлинности в серверной части, используя подходящий метод для вашей среды. Примеры см. в Управление API политиках проверки подлинности и авторизации.

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

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

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

3. В разделе Все API выберите импортированный API.

4. Откройте вкладку Тестирование, чтобы перейти к консоли тестирования.

5. Выберите операцию, введите все необходимые значения и нажмите кнопку Отправить.

   Например, протестируйте вызов GET /$metadata, чтобы проверить подключение к серверной части SAP.

6. Просмотрите ответ. Чтобы устранить неполадки, выполните трассировку вызова.

7. По завершении тестирования закройте консоль тестирования.

Рекомендации для рабочей среды

• Ознакомьтесь с примером комплексного сценария интеграции службы "Управление API" с SAP Gateway.
• Реализуйте управление доступом к серверной части SAP с помощью политик службы "Управление API". Например, если API импортируется как API OData, используйте политику запроса OData. См. также фрагменты политик для распространения субъекта SAP и получения маркера X-CSRF.
• Рекомендации по развертыванию, управлению и переносу API в большом масштабе см. в статье:
  • Автоматизированное развертывание API с помощью APIOps
  • Непрерывная интеграция и непрерывное развертывание службы "Управление API" с помощью шаблонов Azure Resource Manager

См. также

• Ограничения импорта API
• Импорт спецификации OpenAPI
• Импорт SOAP API
• Импорт SOAP API и его преобразование в REST
• Импорт API Службы приложений
• Импорт API контейнерного приложения
• Импорт API WebSocket
• Импорт API GraphQL
• Импорт схемы GraphQL и настройка сопоставителей полей
• Импорт приложения-функции Azure
• Импорт приложения логики Azure
• Импорт службы Service Fabric
• Импорт API OData
• Импорт метаданных SAP OData
• Импорт API gRPC
• Изменение API