You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/sap-api.md
+21-16Lines changed: 21 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Import an SAP API using the Azure portal | Microsoft Docs
2
+
title: Import an SAP API by Using the Azure Portal | Microsoft Docs
3
3
titleSuffix:
4
4
description: Learn how to import OData metadata from SAP as an API to Azure API Management, either directly or by converting the metadata to an OpenAPI specification.
5
5
ms.service: azure-api-management
@@ -9,46 +9,51 @@ author: martinpankraz
9
9
ms.author: mapankra
10
10
ms.topic: how-to
11
11
ms.date: 03/31/2025
12
+
13
+
#customer intent: As an API developer, I want to import an SAP API to API Management.
This article shows how to import an OData service using its metadata description. In this article, [SAP Gateway Foundation](https://help.sap.com/viewer/product/SAP_GATEWAY)serves as an example.
20
+
This article describes how to import an OData service by using its metadata description. [SAP Gateway Foundation](https://help.sap.com/viewer/product/SAP_GATEWAY)is used as an example.
19
21
20
-
In this article, you'll:
22
+
In this article, you:
21
23
> [!div class="checklist"]
22
24
> * Retrieve OData metadata from your SAP service
23
-
> * Import OData metadata to API Management, either directly or after conversion to an OpenAPI specification
25
+
> * Import OData metadata to Azure API Management, either directly or after converting it to an OpenAPI specification
24
26
> * Complete API configuration
25
27
> * Test the API in the Azure portal
26
28
27
29
## Prerequisites
28
30
29
-
- An existing API Management instance. [Create one if you haven't already](get-started-create-service-instance.md).
30
-
- An SAP system and service exposed as OData v2 or v4.
31
-
- If your SAP backend uses a self-signed certificate (for test purposes), you may need to disable the verification of the trust chain for SSL. To do so, configure a [backend](backends.md) in your API Management instance:
31
+
- An API Management instance. If you don't have one, complete the steps in [Create an API Management instance by using the Azure portal](get-started-create-service-instance.md).
32
+
- An SAP system and service that's exposed as OData v2 or v4.
33
+
- If your SAP backend uses a self-signed certificate (for testing), you might need to disable the verification of the trust chain for SSL. To do so, configure a [backend](backends.md) in your API Management instance:
32
34
1. In the Azure portal, under **APIs**, select **Backends** > **+ Add**.
33
-
1. Add a **Custom URL**pointing to the SAP backend service.
34
-
1.Uncheck **Validate certificate chain** and **Validate certificate name**.
35
+
1. Add a **Custom URL**that points to the SAP backend service.
36
+
1.Clear the **Validate certificate chain** and **Validate certificate name** checkboxes.
35
37
36
38
> [!NOTE]
37
-
> For production scenarios, use proper certificates for end-to-end SSL verification.
39
+
> In production scenarios, use proper certificates for end-to-end SSL verification.
40
+
38
41
## Retrieve OData metadata from your SAP service
39
42
40
-
Retrieve metadata XML from your SAP service, using one of the following methods. If you plan to convert the metadata XML to an OpenAPI specification, save the file locally.
43
+
Use one of the following methods to retrieve metadata XML from your SAP service. If you plan to convert the metadata XML to an OpenAPI specification, save the file locally.
41
44
42
-
* Use the SAP Gateway Client (transaction `/IWFND/GW_CLIENT`), or
45
+
* Use the SAP Gateway Client (transaction `/IWFND/GW_CLIENT`).
46
+
or
43
47
* Make a direct HTTP call to retrieve the XML:
44
-
`http://<OData server URL>:<port>/<path>/$metadata`
45
-
48
+
`http://<OData server URL>:<port>/<path>/$metadata`.
Choose one of the following methods to import your API to API Management: import the metadata XML as an OData API directly, or convert the metadata XML to an OpenAPI specification.
54
+
Choose one of the following methods to import your API to API Management:
55
+
- Import the metadata XML as an OData API directly.
56
+
- Convert the metadata XML to an OpenAPI specification.
Copy file name to clipboardExpand all lines: includes/api-management-import-odata-metadata.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,48 +9,47 @@ ms.author: danlep
9
9
---
10
10
## Import OData metadata
11
11
12
-
1. In the left menu, select **APIs** > **+ Add API**.
13
-
1. Under **Create from definition**, select **OData**.
12
+
1. In the left menu, select **APIs** > **APIs**, and then select **+ Add API**.
13
+
1. Under **Create from definition**, select **OData**:
14
14
15
15
:::image type="content" source="media/api-management-import-odata-from-metadata/odata-api.png" alt-text="Screenshot of creating an API from an OData description in the portal." :::
16
16
1. Enter API settings. You can update your settings later by going to the **Settings** tab of the API.
17
17
18
-
1. In **OData specification**, enter a URL for an OData metadata endpoint, typically the URL to the service root, appended with `/$metadata`. Alternatively, select a local OData XML file to import.
18
+
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.
19
19
20
-
1. Enter remaining settings to configure your API. These settings are explained in the [Import and publish your first API](../articles/api-management/import-and-publish.md#import-and-publish-a-backend-api) tutorial.
20
+
1. Enter additional settings to configure your API. These settings are explained in the [Import and publish your first API](../articles/api-management/import-and-publish.md#import-and-publish-a-backend-api) tutorial.
21
21
1. Select **Create**.
22
22
23
-
The API is added to the **APIs**list. The entity sets and functions that are exposed in the OData metadata description appear on the API's **Entity sets and functions** tab.
23
+
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.
24
24
25
-
:::image type="content" source="media/api-management-import-odata-from-metadata/odata-schema.png" alt-text="Screenshot of OData entity sets and functions in the portal." lightbox="media/api-management-import-odata-from-metadata/odata-schema.png" :::
25
+
:::image type="content" source="media/api-management-import-odata-from-metadata/odata-schema.png" alt-text="Screenshot that shows OData entity sets and functions." lightbox="media/api-management-import-odata-from-metadata/odata-schema.png" :::
26
26
27
27
## Update the OData schema
28
28
29
29
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.
30
30
31
31
1. In the [portal](https://portal.azure.com), navigate to your API Management instance.
32
-
1. In the left menu, select **APIs** > your OData API.
33
-
1. On the **Entity sets and functions** tab, select the context menu (**...**) next to an entity set or function, and select **Edit**.
32
+
1. In the left menu, select **APIs**, and then select your OData API.
33
+
1. On the **Entity sets and functions** tab, select the ellipsis (**...**) next to an entity set or function, and then select **Edit**.
34
34
35
-
:::image type="content" source="media/api-management-import-odata-from-metadata/edit-schema.png" alt-text="Screenshot of context menu for an OData entity set in the portal." lightbox="media/api-management-import-odata-from-metadata/edit-schema.png":::
35
+
:::image type="content" source="media/api-management-import-odata-from-metadata/edit-schema.png" alt-text="Screenshot that shows the location of the Edit command." lightbox="media/api-management-import-odata-from-metadata/edit-schema.png":::
36
36
37
37
1. Review the schema. If you want to update it, select **Update from file** or **Update schema from endpoint**.
38
38
39
-
:::image type="content" source="media/api-management-import-odata-from-metadata/odata-schema-update.png" alt-text="Screenshot of schema editor for OData API in the portal." lightbox="media/api-management-import-odata-from-metadata/odata-schema-update.png":::
39
+
:::image type="content" source="media/api-management-import-odata-from-metadata/odata-schema-update.png" alt-text="Screenshot of the schema editor for an OData API." lightbox="media/api-management-import-odata-from-metadata/odata-schema-update.png":::
40
40
41
41
## Test your OData API
42
42
43
-
1. In the left menu, select **APIs** > your OData API.
44
-
1. On the **Entity sets and functions** tab, select the context menu (**...**) next to an entity set or function, and select **Test**.
43
+
1. In the left menu, select **APIs**, and then select your OData API.
44
+
1. On the **Entity sets and functions** tab, select the ellipsis (**...**) next to an entity set or function, and then select **Test**.
45
45
46
-
:::image type="content" source="media/api-management-import-odata-from-metadata/test-entity.png" alt-text="Screenshot of Test option on context menu for an OData entity set in the portal." lightbox="media/api-management-import-odata-from-metadata/test-entity.png":::
47
-
48
-
1. In the test console, enter template parameters, query parameters, and headers for your test, and select **Test**. [Learn more](../articles/api-management/import-api-from-oas.md#test-the-new-api-in-the-portal) about testing an API in the portal.
46
+
:::image type="content" source="media/api-management-import-odata-from-metadata/test-entity.png" alt-text="Screenshot that shows the Test command." lightbox="media/api-management-import-odata-from-metadata/test-entity.png":::
49
47
48
+
1. 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](../articles/api-management/import-api-from-oas.md#test-the-new-api-in-the-portal).
50
49
51
50
## Secure your OData API
52
51
53
-
Secure your OData API by applying both existing [authentication and authorization policies](../articles/api-management/api-management-policies.md#authentication-and-authorization) and an [OData validation policy](../articles/api-management/validate-odata-request-policy.md) to protect against attacks through OData API requests.
52
+
Secure your OData API by applying existing [authentication and authorization policies](../articles/api-management/api-management-policies.md#authentication-and-authorization) and an [OData validation policy](../articles/api-management/validate-odata-request-policy.md) to protect against attacks through OData API requests.
54
53
55
54
> [!TIP]
56
55
> In the portal, configure policies for your OData API on the **API policies** tab.
0 commit comments