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

Import OData metadata

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

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

   

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

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

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

4. Select Create.

   API добавляется в список API. The entity sets and functions that are exposed in the OData metadata description appear on the API's Entity sets and functions tab.

   

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

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

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

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

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

   

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

   

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

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

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

   

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

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

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

Convert OData metadata to OpenAPI JSON

1. Convert the OData XML to OpenAPI JSON format. Используйте открытый инструмент OASIS для OData v2 или OData v4 в зависимости от вашего метаданных 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.

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

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

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

   

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

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

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

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

5. Select Create.

Завершение настройки API

Добавьте следующие три операции в импортированный API:

• GET /$metadata

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

  

• HEAD /

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

  

• GET /

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

  

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

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

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

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

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

4. Select the Test tab to access the test console.

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

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

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

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