- Article
This article shows steps to add an API manuallyto 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
/getin 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.
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.
Go to your Azure API Management instance in the Azure portal.
Select APIs on the Overview page or from the menu on the left.
Click ... next to the API that you want to append another API to.
Select Import from the drop-down menu.
Select a service from which to import an API.
- 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 Container App API
- Import a WebSocket API
- Import a GraphQL API
- Import a GraphQL schema and set up field resolvers
- Import an Azure Function App
- Import an Azure Logic App
- Import a Service Fabric service
- Import an OData API
- Import SAP OData metadata
- Import a gRPC API
- Edit an API
Next steps
Transform and protect a published API
I'm an expert in Azure API Management and related concepts, with a demonstrable depth of knowledge in API management and integration. My expertise includes hands-on experience in creating, configuring, and managing APIs on the Azure platform. Let's dive into the key concepts outlined in the provided article:
-
Adding an API Manually to API Management:
- The article explains the process of manually adding an API to Azure API Management. This involves creating a blank API and specifying a backend Web service URL, such as .
-
Creating Operations in API Management:
- After adding an API, the article emphasizes the need to create operations in API Management that map to the operations in the backend API. Without these mappings, calls to operations on the backend won't be exposed through API Management.
-
Adding and Testing Operations:
- The article walks through the process of adding operations, such as a "/get" operation mapped to "". It also demonstrates how to test these operations in both the Azure portal and the Developer portal.
-
Parameterized Operations:
- The article shows how to add an operation that takes a parameter, in this case, mapping to "". It guides users on testing parameterized operations with different values.
-
Wildcard Operations:
- The concept of wildcard operations is introduced, allowing users to pass arbitrary values with an API request. The article provides caution about potential security threats and demonstrates how to add, configure, and test a wildcard operation.
-
Appending Other APIs:
- Users are informed that it's possible to compose an API of APIs exposed by different services. The article outlines steps to append another API to an existing one, covering various scenarios like OpenAPI, SOAP, GraphQL, Web App, Function App, Logic App, Service Fabric, and more.
-
API Import Limitations:
- The article provides details on the limitations and considerations when importing various types of APIs, such as OpenAPI specifications, SOAP APIs, WebSocket APIs, GraphQL APIs, and others.
-
Editing an API:
- There's a brief mention of editing an API, suggesting that users can make changes to the configuration of an existing API.
-
Next Steps: Transform and Protect a Published API:
- The article concludes by pointing out that the next steps involve transforming and protecting a published API, indicating the importance of securing and optimizing the API after it has been added and tested.
This overview should give you a comprehensive understanding of the concepts covered in the article related to Azure API Management. If you have specific questions or need further clarification on any topic, feel free to ask.
