Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 3.72 KB

api-management-import-odata-metadata.md

File metadata and controls

55 lines (36 loc) · 3.72 KB
author ms.service ms.custom ms.topic ms.date ms.author
dlepow
azure-api-management
build-2024
include
05/06/2024
danlep

Import OData metadata

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

  2. Under Create from definition, select OData:

    :::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." :::

  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.

    :::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" :::

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 portal, navigate to your API Management instance.

  2. In the left menu, select APIs, and then select your OData API.

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

    :::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":::

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

    :::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":::

Test your OData API

  1. In the left menu, select 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.

    :::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":::

  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.

Tip

In the portal, configure policies for your OData API on the API policies tab.