Add an API manually

Article
01/29/2024

This article shows steps to add an API manually to the API Management instance. When you want to mock the API, you can create a blank API or define it manually. For details about mocking an API, see Mock API responses.

If you want to import an existing API, see related topics section.

In this article, we create a blank API and specify httpbin.org (a public testing service) as a backend API.

Prerequisites

Complete the following quickstart: Create an Azure API Management instance

Go to your API Management instance

In the Azure portal, search for and select API Management services.
On the API Management services page, select your API Management instance.

Create an API

Navigate to your API Management service in the Azure portal and select APIs from the menu.
From the left menu, select + Add API.
Select HTTP from the list.
Enter the backend Web service URL (for example, https://httpbin.org) and other settings for the API. The settings are explained in the Import and publish your first API tutorial.
Select Create.

At this point, you have no operations in API Management that map to the operations in your backend API. If you call an operation that is exposed through the back end but not through the API Management, you get a 404.

Note

By default, when you add an API, even if it's connected to some backend service, API Management won't expose any operations until you allow them. To allow an operation of your backend service, create an API Management operation that maps to the backend operation.

Add and test an operation

This section shows how to add a "/get" operation to map it to the back end "http://httpbin.org/get" operation.

Add an operation

Select the API you created in the previous step.
Select + Add Operation.
In the URL, select GET and enter /get in the resource.
Enter "FetchData" for Display name.
Select Save.

Test an operation

Test the operation in the Azure portal. You can also test it in the Developer portal.

Select the Test tab.
Select FetchData.
Press Send.

The response that the "http://httpbin.org/get" operation generates appears. If you want to transform your operations, see Transform and protect your API.

Add and test a parameterized operation

This section shows how to add an operation that takes a parameter. In this case, we map the operation to "http://httpbin.org/status/200".

Add the operation

Select the API you created in the previous step.
Select + Add Operation.
In the URL, select GET and enter /status/{code} in the resource. Optionally, you can provide some information associated with this parameter. For example, enter "Number" for TYPE, "200" (default) for VALUES.
Enter "GetStatus" for Display name.
Select Save.

Test the operation

Test the operation in the Azure portal. You can also test it in the Developer portal.

Select the Test tab.
Select GetStatus. By default the code value is set to "200". You can change it to test other values. For example, type "418".
Press Send.

The response that the "http://httpbin.org/status/200" operation generates appears. If you want to transform your operations, see Transform and protect your API.

Add and test a wildcard operation

This section shows how to add a wildcard operation. A wildcard operation lets you pass an arbitrary value with an API request. Instead of creating separate GET operations as shown in the previous sections, you could create a wildcard GET operation.

Caution

Use care when configuring a wildcard operation. This configuration may make an API more vulnerable to certain API security threats.

Add the operation

Select the API you created in the previous step.
Select + Add Operation.
In the URL, select GET and enter /* in the resource.
Enter "WildcardGet" for Display name.
Select Save.

Test the operation

Test the operation in the Azure portal. You can also test it in the Developer portal.

Select the Test tab.
Select WildcardGet. Try the GET operations that you tested in previous sections, or try a different supported GET operation.

For example, in Template parameters, update the value next to the wildcard (*) name to headers. The operation returns the incoming request's HTTP headers.
Press Send.

The response that the "http://httpbin.org/headers" operation generates appears. If you want to transform your operations, see Transform and protect your API.

Note

It can be important to understand how the host for the backend API you're integrating with handles trailing slashes on an operation URL. For more information, see this API Management FAQ.