Skip to content

Commit 3e4eca6

Browse files
authored
Merge pull request #313138 from cdpark/refresh-apicenter-march5
Feature 551038: Q&M: Content Freshness for API Center - March 5
2 parents 091d424 + da46f7c commit 3e4eca6

12 files changed

Lines changed: 104 additions & 70 deletions
-69.3 KB
Loading
-39.6 KB
Loading
-75.6 KB
Loading
-83.7 KB
Loading
-135 KB
Loading
-91.7 KB
Loading
-70.4 KB
Loading

articles/api-management/mock-api-responses.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Tutorial - Mock API responses in API Management - Azure portal | Microsoft Docs
3-
description: Use Azure API Management to set a policy on an API. The policy returns a mock response even if the backend isn't available to send real responses.
2+
title: "Tutorial: Mock API Responses in API Management"
3+
description: Use Azure API Management to set a policy on an API to return a mock response even if the backend isn't available to send real responses.
44

55
author: dlepow
66
ms.service: azure-api-management
77
ms.topic: tutorial
8-
ms.date: 03/24/2025
8+
ms.date: 03/12/2026
99
ms.author: danlep
1010
ms.custom:
1111
- mvc
@@ -21,20 +21,20 @@ ms.custom:
2121

2222
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
2323

24-
Backend APIs are imported into an Azure API Management API or created and managed manually. The steps in this tutorial describe how to:
24+
Backend APIs can be imported into an Azure API Management API or created and managed manually. The steps in this tutorial describe how to:
2525

2626
+ Use API Management to create a blank HTTP API.
2727
+ Manually manage an HTTP API.
2828
+ Set a policy on an API so that it returns a mock response.
2929

30-
This method enables developers to continue with the implementation and testing of the API Management instance even if the backend isn't available to send real responses.
30+
This method allows developers to continue with the implementation and testing of the API Management instance even if the backend isn't available to send real responses.
3131

3232
[!INCLUDE [api-management-workspace-try-it](../../includes/api-management-workspace-try-it.md)]
3333

3434
The ability to create mock responses is useful in many scenarios:
3535

36-
+ When the API façade is designed first and the backend implementation occurs later, or when the backend is being developed in parallel.
37-
+ When the backend is temporarily not operational or is not able to scale.
36+
+ When the API gateway is designed first and the backend implementation occurs later, or when the backend is being developed in parallel.
37+
+ When the backend is temporarily not operational or isn't able to scale.
3838

3939
In this tutorial, you learn how to:
4040

@@ -56,15 +56,20 @@ In this tutorial, you learn how to:
5656

5757
The steps in this section show how to create an HTTP API with no backend.
5858

59-
1. Sign in to the Azure portal, and then navigate to your API Management instance.
60-
1. Select **APIs** > **+ Add API** > **HTTP** tile:
59+
1. Sign in to the [Azure portal](https://portal.azure.com/), and then navigate to your API Management instance.
60+
61+
1. In the sidebar menu, select **APIs** > **APIs**, and then select **+ Add API**. Choose the **HTTP** tile:
6162

6263
:::image type="content" source="media/mock-api-responses/http-api.png" alt-text="Screenshot that shows the first steps for defining an API." lightbox="media/mock-api-responses/http-api.png":::
6364

6465
1. In the **Create an HTTP API** window, select **Full**.
65-
1. In **Display name**, enter *Test API*.
66+
67+
1. In **Display name**, enter *Test API*. The **Name** field fills automatically.
68+
6669
1. In **Products**, select *Unlimited*, if that value is available. This value is available only in some tiers. You can leave the value blank for this tutorial, but you need to associate the API with a product to publish it. For more information, see [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api).
70+
6771
1. In **Gateways**, select **Managed** if this option is available. (This option is available only in certain service tiers.)
72+
6873
1. Select **Create**.
6974

7075
:::image type="content" source="media/mock-api-responses/create-http-api.png" alt-text="Screenshot that shows the Create an HTTP API window." lightbox="media/mock-api-responses/create-http-api.png":::
@@ -76,26 +81,33 @@ An API exposes one or more operations. In this section, you add an operation to
7681
### [Portal](#tab/azure-portal)
7782

7883
1. Select the API that you created in the previous step.
84+
7985
1. Select **+ Add Operation**.
86+
8087
1. In the **Frontend** window, enter the following values:
8188

82-
| Setting | Value | Description |
83-
|------|------|-----------------------------------------|
84-
| **Display name** | *Test call* | The name that's displayed in the [developer portal](api-management-howto-developer-portal.md). |
89+
| Setting | Value | Description |
90+
|------------------|---------------|-----------------|
91+
| **Display name** | *Test call* | The name displayed in the [developer portal](api-management-howto-developer-portal.md). |
92+
| **Name** | *test-call* | This field fills automatically. |
8593
| **URL** (first box) | GET | Select one of the predefined HTTP verbs. |
8694
| **URL** (second box)| */test* | A URL path for the API. |
87-
| **Description** | | An optional description of the operation. It provides documentation in the developer portal to the developers who use the API. |
95+
| **Description** | | An optional description of the operation. It provides documentation in the developer portal to the developers who use the API. |
8896

8997
:::image type="content" source="media/mock-api-responses/frontend-window.png" alt-text="Screenshot that shows the Frontend window." lightbox="media/mock-api-responses/frontend-window.png":::
9098

91-
1. Select the **Responses** tab, which is located under the **URL**, **Display name**, and **Description** boxes. You'll enter values on this tab to define response status codes, content types, examples, and schemas.
99+
1. Select the **Responses** tab, which is located under the **URL**, **Display name**, and **Description** boxes. Enter values on this tab to define response status codes, content types, examples, and schemas.
100+
92101
1. Select **+ Add response**, and then select **200 OK** from the list.
93102

94103
:::image type="content" source="media/mock-api-responses/add-response.png" alt-text="Screenshot that shows the Responses tab." lightbox="media/mock-api-responses/add-response.png":::
95104

96105
1. In the **Representations** section, select **+ Add representation**.
106+
97107
1. Enter *application/json* into the search box and then select the **application/json** content type.
108+
98109
1. In the **Sample** box, enter `{ "sampleField" : "test" }`.
110+
99111
1. Select **Save**.
100112

101113
:::image type="content" source="media/mock-api-responses/add-representation.png" alt-text="Screenshot that shows the Representations section." lightbox="media/mock-api-responses/add-representation.png":::
@@ -105,7 +117,7 @@ Although it's not required for this example, you can configure more settings for
105117
|Tab |Description |
106118
|---------|---------|
107119
|**Query** | Add query parameters. Besides providing a name and description, you can also provide values that are assigned to a query parameter. You can mark one of the values as default (optional). |
108-
|**Request** | Define request content types, examples, and schemas. |
120+
|**Request** | Define request content types, examples, and schemas. |
109121

110122
### [Azure CLI](#tab/azure-cli)
111123

@@ -141,8 +153,11 @@ az apim api operation delete --resource-group <resource-group-name> \
141153
## Enable response mocking
142154

143155
1. Select the API you created in [Create a test API](#create-a-test-api).
156+
144157
1. Ensure that the **Design** tab is selected.
145-
1. Select the test operation that you added.
158+
159+
1. Select the **Test call** operation that you added.
160+
146161
1. In the **Inbound processing** section, select **+ Add policy**.
147162

148163
:::image type="content" source="media/mock-api-responses/add-policy.png" alt-text="Screenshot that shows the first steps for enabling response mocking." lightbox="media/mock-api-responses/add-policy.png" :::
@@ -158,11 +173,12 @@ az apim api operation delete --resource-group <resource-group-name> \
158173
1. Select **Save**.
159174

160175
> [!TIP]
161-
> A yellow bar displaying the text **Mocking is enabled** appears. This message indicates that the responses returned from API Management are mocked by the [mocking policy](mock-response-policy.md) and aren't produced by the backend.
176+
> A yellow bar displaying the text **Mocking is enabled** appears. This message indicates that the responses returned from API Management are issued by the [mocking policy](mock-response-policy.md) and aren't produced by the backend.
162177
163178
## Test the mocked API
164179

165180
1. Select the API you created in [Create a test API](#create-a-test-api).
181+
166182
1. On the **Test** tab, ensure that the **Test call** API is selected, and then select **Send** to make a test call:
167183

168184
:::image type="content" source="media/mock-api-responses/test-mock-api.png" alt-text="Screenshot that shows the steps for testing the mocked API." lightbox="media/mock-api-responses/test-mock-api.png":::
@@ -173,7 +189,5 @@ az apim api operation delete --resource-group <resource-group-name> \
173189

174190
## Next step
175191

176-
Go to the next tutorial:
177-
178192
> [!div class="nextstepaction"]
179193
> [Transform and protect a published API](transform-api.md)

articles/api-management/restify-soap-api.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Import a SOAP API to Azure API Management and convert it to REST using the portal | Microsoft Docs
3-
description: Learn how to import a SOAP API into Azure API Management as a WSDL specification and convert it to a REST API. Then test the API in the Azure portal.
2+
title: Import a SOAP API into API Management and Convert it to REST
3+
description: Learn how to import a SOAP API into Azure API Management as a WSDL specification and convert it to a REST API.
44
services: api-management
55
author: dlepow
66
ms.custom: devdivchpfy22
77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 03/27/2025
9+
ms.date: 03/13/2026
1010
ms.author: danlep
1111

1212
#customer intent: As a developer, I want to import a SOAP API into API Management and convert it to REST.
1313

1414
---
15-
# Import a SOAP API to API Management and convert it to REST
15+
# Import a SOAP API into Azure API Management and convert it to REST
1616

1717
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1818

@@ -28,37 +28,42 @@ In this article, you learn how to:
2828

2929
## Prerequisites
3030

31-
- Complete the quickstart [Create an Azure API Management instance](get-started-create-service-instance.md).
31+
- Create an [Azure API Management instance](get-started-create-service-instance.md).
3232

3333
[!INCLUDE [api-management-navigate-to-instance.md](../../includes/api-management-navigate-to-instance.md)]
3434

3535
## <a name="create-api"> </a>Import and publish a backend API
3636

37-
1. In the left pane, in the **APIs** section, select **APIs**.
37+
1. In the sidebar menu, in the **APIs** section, select **APIs**.
38+
3839
1. On the APIs page, select **+ Add API**.
39-
1. Under **Create from definition**, select **WSDL**:
40+
41+
1. Under **Create from definition**, select the **WSDL** tile:
4042

4143
:::image type="content" source="./media/restify-soap-api/wsdl-api.png" alt-text="Screenshot that shows the WSDL tile in the Azure portal.":::
4244

43-
1. In **WSDL specification**, enter the URL to your SOAP API, or click **Select a file** to select a local WSDL file.
44-
1. Under **Import method**, select **SOAP to REST**.
45+
1. In **WSDL specification**, enter the URL to your SOAP API, or choose **Select a file** to select a local WSDL file.
46+
47+
1. Under **Import method**, select **SOAP to REST**.
48+
4549
When this option is selected, API Management attempts to make an automatic transformation between XML and JSON. In this case, consumers should call the API as a RESTful API, which returns JSON. API Management converts each request to a SOAP call.
4650

4751
:::image type="content" source="./media/restify-soap-api/soap-to-rest.png" alt-text="Screenshot that shows the SOAP to REST option." lightbox="./media/restify-soap-api/soap-to-rest.png":::
4852

4953
1. The **Display name** and **Name** boxes are filled automatically with information from the SOAP API.
50-
51-
**Display name**, **URL**, and **Description** information is automatically entered for operations. Operations also receive a system-generated **Name**.
54+
5255
1. Enter other API settings, and then select **Create**. You can also configure these values later by going to the **Settings** tab.
5356

54-
For more information about API settings, see [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api).
57+
For more information about API settings, see [Import and publish a backend API](import-and-publish.md#import-and-publish-a-backend-api).
5558

5659
## Test the new API in the Azure portal
5760

5861
You can call operations directly from the Azure portal. This method provides a convenient way to view and test the operations of an API.
5962

6063
1. Select the API you created in the previous step.
64+
6165
1. Select the **Test** tab.
66+
6267
1. Select an operation.
6368

6469
The page shows fields for query parameters and fields for the headers. One of the headers is **Ocp-Apim-Subscription-Key**. This header is for the subscription key of the product that's associated with this API. If you created the API Management instance, you're an admin already, so the key is filled in automatically.

0 commit comments

Comments
 (0)