Import an OpenAPI specification

This article shows how to import an "OpenAPI specification" back-end API residing at https://conferenceapi.azurewebsites.net?format=json. This back-end API is provided by Microsoft and hosted on Azure. The article also shows how to test the APIM API.

In this article, you learn how to:

  • Import an "OpenAPI specification" back-end API
  • Test the API in the Azure portal
  • Test the API in the Developer portal

Prerequisites

Complete the following quickstart: Create an Azure API Management instance

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 screen, select your API Management instance.

    Select your API Management instance

Import and publish a back-end API

  1. Navigate to your API Management service in the Azure portal and select APIs from the menu.

  2. Select OpenAPI specification from the Add a new API list.

    OpenAPI specification

  3. Enter API settings. You can set the values during creation or configure them later by going to the Settings tab. The settings are explained in the Import and publish your first API tutorial.

  4. Select Create.

Note

The API import limitations are documented in another article.

Append other APIs

An API can be composed of APIs exposed by different services, including the OpenAPI Specification, a SOAP API, the API Apps feature of Azure App Service, Azure Function App, Azure Logic Apps, and Azure Service Fabric.

Import an API

To append a different API to your existing API, complete the following steps. 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.
  2. Select APIs from the menu on the left.
  3. Click ... next to the API that you want to append another API to.
  4. Select Import from the drop-down menu.
  5. Select a service from which to import an API.

Next steps