Edit

Share via

Import an OData API

  • Article

APPLIES TO: All API Management tiers

This article shows how to import an OData-compliant service as an API in API Management.

In this article, you learn how to:

  • Import an OData metadata description using the Azure portal
  • Manage the OData schema in the portal
  • Secure the OData API

Prerequisites

Go to your API Management instance

  1. In the Azure portal, search for and select API Management services.

    Select API Management services

  2. On the API Management services page, select your API Management instance.

    Select your API Management instance

Import OData metadata

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

  2. Under Create from definition, select OData.

    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, typically the URL to the service root, appended with /$metadata. Alternatively, select a local OData XML file to import.

    2. Enter remaining 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 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.

    Screenshot of OData entity sets and functions in the portal.

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 > your OData API.

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

    Screenshot of context menu for an OData entity set in the portal.

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

    Screenshot of schema editor for OData API in the portal.

Test your OData API

  1. In the left menu, select APIs > your OData API.

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

    Screenshot of Test option on context menu for an OData entity set in the portal.

  3. In the test console, enter template parameters, query parameters, and headers for your test, and select Test. Learn more about testing an API in the portal.

Secure your OData API

Secure your OData API by applying both 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.

Append other APIs

You can compose an API of APIs exposed by different services, including:

  • An OpenAPI specification
  • A SOAP API
  • A GraphQL API
  • A Web App hosted in Azure App Service
  • Azure Function App
  • Azure Logic Apps
  • Azure Service Fabric

Append a different API to your existing API using the following steps.

Note

When you import another API, the operations are appended to your current API.

  1. Go to your Azure API Management instance in the Azure portal.

    Screenshot of navigating to API Management instance in the portal.

  2. Select APIs on the Overview page or from the menu on the left.

    Screenshot of selecting APIs on Overview page in the portal.

  3. Click ... next to the API that you want to append another API to.

  4. Select Import from the drop-down menu.

    Select import

  5. Select a service from which to import an API.

    Screenshot of selecting a service in the portal.