Exercise - Integrate openAPI enabled web API with Azure API Management

  • 8 minutes

In this exercise, you integrate your web API application running on Azure App Service with Azure API Management through Visual Studio.

Note

In the previous exercise, you already have the ASP.NET Core Web API app with the OpenAPI feature enabled. You'll use the app for this exercise.

Integrate Web API Application with Azure API Management through Visual Studio

The web API application is ready to publish. In order to deploy the web API application, run the following steps.

  1. In Solution Explorer, right-click the project and select the Publish menu.

    Screenshot that shows how to select the publish menu.

  2. In the Publish dialogue modal, select Azure and select the Next button.

    Choose Publish Target.

  3. Select Azure App Service (Windows) and select the Next button.

    Choose Specific Target.

  4. As you have already published your web API app to an Azure App Service instance in the previous unit, you can see it in the dialogue modal. Select the App Service instance and select the Next button.

    Choose Existing App Service.

  5. While you can use an existing Azure API Management instance, if you like, for this time, let's create a new one through Visual Studio. Select the ➕ button at the right-hand side of the dialogue modal to create a new Azure API Management instance.

    Select Create New API Management.

  6. When a new API in API Management dialogue modal pops up, all mandatory field values have already been automatically populated. You can use the prepopulated ones or change them. Fill in all the field values. However, there's no API Management instance yet. Select the New... button at the right-hand side of the dialogue modal.

    Create New API in API Management.

  7. Another pop-up dialogue modal appears to create a new Azure API Management instance. All field values have already been populated. You can use or change them. Then select the OK button.

    Create New API Management.

  8. Once the Azure API Management dialogue modal closes, the API in API Management modal shows the API Management instance name. Select the Create button.

    Create New API in API Management Filled.

  9. The Azure API Management instance is ready to integrate the web API app on the Azure App Service instance. Select the Finish button.

    Finish API Management Publish.

  10. Your web API app is ready to deploy. Check the Service Dependencies message at the bottom of Visual Studio window, and confirm that the Azure API Management instance is also configured for integration. Select the Publish button at the right-top corner of Visual Studio.

    Publish Web API.

  11. Once the web API app is published, Visual Studio notifies you through a banner.

    Web API Published.

As you also created the Azure API Management instance and integrated the web API app with it, you should be able to verify it on Azure portal.

Verify Web API Integration on Azure API Management

  1. To verify whether your web API has been integrated with Azure API Management, open a web browser and sign in to Azure portal. Enter the keyword, api management, in the search bar at the top of the Azure portal. When the API Management services appears, select it.

    Search API Management.

  2. Select your Azure API Management instance.

    API Management Instances.

  3. On the left menu under APIs, select the Inventory Management API. Choose the /api/WarehouseLocations - GET operation and select the Test tab in the middle of the page.

    API Management - API.

  4. Select the Send button to send a test request to the web API.

    API Management - API Test.

  5. The response from the API request is shown.

    API Management - API Test Result.

Congratulations! You've now integrated your web API app with Azure API Management through Visual Studio!