Skip to content

Commit 41a0fda

Browse files
author
gitName
committed
draft complete
1 parent 8db97ef commit 41a0fda

File tree

3 files changed

+21
-8
lines changed

3 files changed

+21
-8
lines changed

articles/api-management/import-api-from-oas.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom: engagement-fy23, devx-track-azurepowershell, devx-track-azurecli
1414

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

17-
This article shows how to import an "OpenAPI specification" backend API to Azure API Management using a variety of tools. The article also shows how to test the API in API Management.
17+
This article shows how to import an "OpenAPI specification" backend API to Azure API Management using various tools. The article also shows how to test the API in API Management.
1818

1919
In this article, you learn how to:
2020
> [!div class="checklist"]
@@ -37,7 +37,7 @@ In this article, you learn how to:
3737

3838
## <a name="create-api"> </a>Import a backend API
3939

40-
For this example, you import the [specification](https://petstore3.swagger.io/api/v3/openapi.json) for the open source [Petstore API](https://petstore3.swagger.io/), but you can substitute an OpenAPI specification of your choice.
40+
For this example, you import the [OpenAPI specification](https://petstore3.swagger.io/api/v3/openapi.json) for the open source [Petstore API](https://petstore3.swagger.io/), but you can substitute an OpenAPI specification of your choice.
4141

4242

4343
#### [Portal](#tab/portal)
@@ -99,16 +99,29 @@ After importing the API, if needed, you can update the settings by using the [Se
9999

100100
---
101101

102-
[!INCLUDE [api-management-test-api-portal](../../includes/api-management-test-api-portal.md)]
102+
## View and edit OpenAPI specification
103103

104-
[!INCLUDE [api-management-append-apis.md](../../includes/api-management-append-apis.md)]
104+
In the portal, use the OpenAPI specification editor to view, validate, or edit the specification for the API that you imported.
105105

106-
[!INCLUDE [api-management-define-api-topics.md](../../includes/api-management-define-api-topics.md)]
106+
TO use the OpenAPI specification editor:
107+
108+
1. In the Azure portal, navigate to your API Management instance.
109+
1. In the left menu, under **APIs**, select **APIs** > **\<your API\>** > **All operations**.
110+
1. On the **Design** tab, in **Frontend**, select **OpenAPI Specification editor** (pencil icon). You can open the specification in JSON or YAML format.
111+
1. Review or edit the specification as needed. **Save** your changes.
107112

108113
## Validate against an OpenAPI specification schema
109114

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

117+
118+
[!INCLUDE [api-management-test-api-portal](../../includes/api-management-test-api-portal.md)]
119+
120+
[!INCLUDE [api-management-append-apis.md](../../includes/api-management-append-apis.md)]
121+
122+
[!INCLUDE [api-management-define-api-topics.md](../../includes/api-management-define-api-topics.md)]
123+
124+
112125
## Next steps
113126

114127
> [!div class="nextstepaction"]

includes/api-management-append-apis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Append a different API to your existing API using the following steps.
2323
2424
1. Go to your Azure API Management instance in the Azure portal.
2525

26-
:::image type="content" source="./media/api-management-append-apis/service-page-1.png" alt-text="Go to Azure API Mgmt instance":::
26+
:::image type="content" source="./media/api-management-append-apis/service-page-1.png" alt-text="Screenshot of navigating to API Management instance in the portal.":::
2727

2828
1. Select **APIs** on the **Overview** page or from the menu on the left.
2929

30-
:::image type="content" source="./media/api-management-append-apis/api-select-1.png" alt-text="Select APIs":::
30+
:::image type="content" source="./media/api-management-append-apis/api-select-1.png" alt-text="Screenshot of selecting APIs on Overview page in the portal.":::
3131

3232
1. Click **...** next to the API that you want to append another API to.
3333
1. Select **Import** from the drop-down menu.
@@ -36,4 +36,4 @@ Append a different API to your existing API using the following steps.
3636

3737
1. Select a service from which to import an API.
3838

39-
:::image type="content" source="./media/api-management-append-apis/select-to-import.png" alt-text="Select service":::
39+
:::image type="content" source="./media/api-management-append-apis/select-to-import.png" alt-text="Screenshot of selecting a service in the portal.":::
-1.28 KB
Loading

0 commit comments

Comments
 (0)