Import an OpenAPI specification

APPLIES TO: All API Management tiers

This article shows how to import an "OpenAPI specification" backend API residing at https://conferenceapi.chinacloudsites.cn?format=json. This backend 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:

Prerequisites

• An API Management instance. If you don't already have one, complete the following quickstart: Create an Azure API Management instance.

• Azure CLI

  You can use the local Azure CLI.

  • If you prefer, install the Azure CLI to run CLI reference commands.

  • Local Azure CLI, see how to install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.

    • Sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.

    • When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.

    • Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

• Azure PowerShell

  • If you choose to use Azure PowerShell locally:
    • Install the latest version of the Az PowerShell module.
    • Connect to your Azure account using the Connect-AzAccount -Environment AzureChinaCloud cmdlet.

Import a backend API

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="demo-conference-api"
APIPath="conference"
SpecificationFormat="OpenAPI"
SpecificationURL="https://conferenceapi.chinacloudsites.cn/?format=json"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "demo-conference-api"
$apiPath = "conference"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://conferenceapi.chinacloudsites.cn/?format=json"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

author: Johnnytechn ms.service: api-management ms.topic: include ms.date: 04/12/2023 ms.author: v-johya

Test the new API in the portal

Operations can be called directly from the portal, which provides a convenient way for administrators to view and test the operations of an API.

1. Select the API you created in the previous step.

2. Select the Test tab.

3. Select an operation.

   The page displays fields for query parameters and fields for the headers.

   Note

   In the test console, API Management automatically populates an Ocp-Apim-Subscription-Key header, and configures the subscription key of the built-in all-access subscription. This key enables access to every API in the API Management instance. Optionally display the Ocp-Apim-Subscription-Key header by selecting the "eye" icon next to the HTTP Request.

4. Depending on the operation, enter query parameter values, header values, or a request body. Select Send.

   When the test is successful, the backend responds with 200 OK and some data.

To debug an API, see Tutorial: Debug your APIs using request tracing.

Append other APIs

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

• The OpenAPI Specification
• A SOAP 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.

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

   

2. Select APIs on the Overview page or 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.

   

Related topics

• API import limitations
• Import an OpenAPI specification
• Import a SOAP API
• Import a SOAP API and convert to REST
• Import an App Service API
• Import a WebSocket API
• Import a GraphQL API
• Import an Azure Function App
• Import an Azure Logic App
• Import a Service Fabric service
• Import SAP OData metadata
• Edit an API

Validate against an OpenAPI specification

You can configure API Management validation policies to validate requests and responses (or elements of them) against the schema in an OpenAPI specification. For example, use the validate-content policy to validate the size or content of a request or response body.

Next steps