Import SAP OData metadata as an API

Convert OData metadata to OpenAPI JSON

1. Use the Microsoft converter built on-top of the OASIS open-source tool.

   The following example converts OData v2 XML for the test service epm_ref_apps_prod_man_srv:

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Note

   For testing with a single XML file, you can use the web-based experience.

2. Save the openapi-spec.json file locally for import to API Management.

Import OpenAPI specification

1. In the sidebar menu, in the APIs section, select APIs.

2. Under Create from definition, select the OpenAPI tile:

   

3. Choose Select a file, and then select the openapi-spec.json file that you saved locally in a previous step.

4. Enter API settings. You can set these values when you import the API or configure them later by going to the Settings tab.

   • For the API URL suffix, we recommend using the same URL path as that of the original SAP service.

   • For more information about API settings, see Import and publish your first API tutorial.

5. Select Create.

You also need to configure authentication to your backend by using an appropriate method for your environment. For examples, see Authentication and authorization.

Test your API

1. Navigate to your API Management instance.

2. In the sidebar menu, select APIs > APIs.

3. Under All APIs, select your imported API.

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

5. Select an operation, enter any required values, and then select Send.

   For example, test the GET /$metadata call to verify connectivity to the SAP backend.

6. View the response. To troubleshoot, trace the call.

7. When you're done testing, exit the test console.

Import OData metadata

1. In the sidebar menu, select APIs > APIs, and then select + Add API.

2. Under Create from definition, select the OData tile:

   

3. Enter API settings. You can update your settings later by going to the Settings tab of the API.

   1. In OData specification, enter a URL for an OData metadata endpoint. This value is typically the URL to the service root, appended with /$metadata. Alternatively, select a local OData XML file to import.

   2. Enter additional settings to configure your API. These settings are explained in the Import and publish your first API tutorial.

4. Select Create.

   The API is added to the list of APIs. The entity sets and functions that are exposed in the OData metadata description appear on the API's Entity sets and functions tab.

   

Update the OData schema

You can access an editor in the portal to view your API's OData schema. If the API changes, you can also update the schema in API Management from a file or an OData service endpoint.

1. In the sidebar menu, APIs > APIs, and then select your OData API.

2. On the Entity sets and functions tab, select the ellipsis (...) next to an entity set or function, and then select Edit.

   

3. Review the schema. If you want to update it, select Update from file or Update schema from endpoint.

   

Test your OData API

1. In the sidebar menu, APIs > APIs, and then select your OData API.

2. On the Entity sets and functions tab, select the ellipsis (...) next to an entity set or function, and then select Test.

   

3. In the test console, enter template parameters, query parameters, and headers for your test, and then select Test. For more information about testing APIs in the portal, see Test the new API in the portal.

Secure your OData API

Secure your OData API by applying existing authentication and authorization policies and an OData validation policy to protect against attacks through OData API requests.