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

ПРИМЕНЯЕТСЯ КО ВСЕМ уровням управления API

В этой статье описывается, как импортировать службу OData (Open Data Protocol) в службу управления API Azure с помощью метаданных OData. В следующем примере используется SAP Gateway Foundation.

В этой статье вы узнаете, как:

• Получите метаданные OData из вашего сервиса SAP
• Импорт метаданных OData в Azure API Management напрямую или после преобразования в спецификацию OpenAPI
• Полная конфигурация API
• Тестирование API на портале Azure

Предпосылки

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

• Система и служба SAP, размещенные как OData v2 или v4.

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

  1. На портале Azure в разделе API выберите Backends>.
  2. Добавьте пользовательский URL-адрес , указывающий на серверную службу SAP.
  3. Разверните раздел "Дополнительно", а затем снимите флажки "Проверить цепочку сертификатов" и "Проверить имя сертификата".

  Примечание

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

  Подсказка

  Для полной области управления API преобразуйте API SAP OData в спецификацию OpenAPI перед регистрацией.

Получите метаданные OData из вашего сервиса SAP

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

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

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

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

   

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

   

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

Выберите один из следующих методов импорта API в управление API:

• Преобразуйте XML метаданных в спецификацию OpenAPI (рекомендуется).
• Импортируйте XML метаданных как API OData напрямую.

Спецификация OpenAPI (рекомендуется)

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

1. Используйте преобразователь Microsoft, построенный на основе средства с открытым исходным кодом OASIS.

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

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Примечание

   Для тестирования с помощью одного XML-файла можно использовать веб-интерфейс.

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

Импорт спецификации OpenAPI

1. В меню боковой панели в разделе API выберите API.

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

   

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

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

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

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

5. Нажмите кнопку "Создать".

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

Примечание

Сведения об ограничениях импорта API см. в разделе "Ограничения импорта API" и известные проблемы.

Протестируйте ваш API

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

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

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

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

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

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

6. Просмотрите ответ. Для устранения неполадок отследите вызов.

7. Завершив тестирование, закройте тестовую консоль.

Метаданные OData

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

1. В меню боковой панели выберите API-интерфейсы> и нажмите кнопку +Добавить API.

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

   

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

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

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

4. Нажмите кнопку "Создать".

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

   

Обновите схему OData

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

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

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

   

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

   

Проверьте ваш OData API

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

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

   

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

Защитите ваш OData API

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

Подсказка

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

Факторы, учитываемые при производстве

• Используйте Defender для API для полной защиты, детектирования и охвата всех аспектов жизненного цикла API.
• Пример комплексного сценария интеграции управления API с шлюзом SAP.
• Управление доступом к серверной части SAP с помощью политик управления API. Например, если API импортирован как OData API, используйте политику проверки запроса OData. Существуют также фрагменты политик для распространения привилегий SAP для SAP ECC или S/4HANA или SAP SuccessFactors и получения токена X-CSRF.
• Рекомендации по развертыванию, управлению и переносу API в большом масштабе см. в статье:
  • автоматизированные развертывания API с помощью APIOps
  • Использование DevOps и CI/CD для публикации API

Связанный контент

• Ограничения импорта API
• Импорт спецификации OpenAPI
• Импортируйте SOAP API
• импортируйте API SOAP и преобразуйте его в REST
• Импорт API Службы приложений
• Импорт API приложения-контейнера
• Импортируйте API WebSocket
• Импортируйте API GraphQL
• Импортируйте схему GraphQL и настройте разрешители полей
• Импорт API приложения-функции
• Импорт API приложения логики
• Импорт службы «Service Fabric»
• Импорт API Microsoft Foundry
• Импорт API Azure OpenAI
• Импорт API модели LLM
• Импортировать API OData
• Экспорт REST API в качестве сервера MCP
• Предоставление существующего сервера MCP
• Импорт API агента A2A
• Импорт метаданных SAP OData
• Импортируйте gRPC API
• Изменение API