You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**Display name**|*Blank API*|This name is displayed in the Developer portal.|
45
-
|**Name**|*blank-api*|Provides a unique name for the API.|
46
-
|**Web Service URL** (optional)|*https://httpbin.org*| If you want to mock an API, you might not enter anything. <br/>In this case, we enter [https://httpbin.org](https://httpbin.org). This is a public testing service. <br/>If you want to import an API that is mapped to a back end automatically, see one of the topics in the [related topics](#related-topics) section.|
47
-
|**URL scheme**|*HTTPs*|In this case, even though the back end has non-secure HTTP access, we specify a secure HTTPS APIM access to the back end. <br/>This kind of scenario (HTTPS to HTTP) is called HTTPS termination. You might do it if your API exists within a virtual network (where you know the access is secure even if HTTPS is not used). <br/>You might want to use "HTTPS termination" to save on some CPU cycles.|
48
-
|**URL suffix**|*hbin*| The suffix is a name that identifies this specific API in this APIM instance. It has to be unique in this APIM instance.|
49
-
|**Products**|*Unlimited*|Publish the API by associating the API with a product. If you want for the API to be published and be available to developers, add it to a product. You can do it during API creation or set it later.<br/><br/>Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. <br/>Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the APIM instance, you are an administrator already, so you are subscribed to every product by default.<br/><br/> By default, each API Management instance comes with two sample products: **Starter** and **Unlimited**.|
4. Enter settings for the API. The settings are explained in the [Import and publish your first API](import-and-publish.md#-import-and-publish-a-backend-api) tutorial.
50
40
5. Select **Create**.
51
41
52
-
At this point, you have no operations in APIM that map to the operations in your back-end API. If you call an operation that is exposed through the back end but not through the APIM, you get a **404**.
42
+
At this point, you have no operations in API Management that map to the operations in your back-end API. If you call an operation that is exposed through the back end but not through the API Management, you get a **404**.
53
43
54
44
>[!NOTE]
55
45
> By default, when you add an API, even if it is connected to some back-end service, APIM will not expose any operations until you whitelist them. To whitelist an operation of your back-end service, create an APIM operation that maps to the back-end operation.
Copy file name to clipboardExpand all lines: articles/api-management/import-and-publish.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,14 +57,15 @@ This section shows how to import and publish an OpenAPI Specification backend AP
57
57
|**Description**|After you enter the preceding service URL, API Management fills out this field based on the JSON.|An optional description of the API.|
58
58
|**URL scheme**|**HTTPS**|Which protocols can be used to access the API.|
59
59
|**API URL suffix**|*conference*|The suffix appended to the base URL for the API Management service. API Management distinguishes APIs by their suffix, so the suffix must be unique for every API for a given publisher.|
60
-
|**Products**|**Unlimited**|Association of one or more APIs. Each API Management instance comes with two sample products: **Starter** and **Unlimited**. You publish an API by associating the API with a product, **Unlimited** in this example.<br/>You can include several APIs in a product and offer them to developers through the developer portal. To add this API to another product, type or select the product name. Repeat this step to add the API to multiple products. You can also add APIs to products later from the **Settings** page.<br/>To get access to the API, developers must first subscribe to a product. When they subscribe, they get a subscription key that's good for any API in that product. <br/>If you created the API Management instance, you're an administrator already, so you're subscribed to every product in the instance.|
61
60
|**Tags**||Tags for organizing APIs for searching, grouping, or filtering.|
61
+
|**Products**|**Unlimited**|Association of one or more APIs. Each API Management instance comes with two sample products: **Starter** and **Unlimited**. You publish an API by associating the API with a product, **Unlimited** in this example.<br/>You can include several APIs in a product and offer them to developers through the developer portal. To add this API to another product, type or select the product name. Repeat this step to add the API to multiple products. You can also add APIs to products later from the **Settings** page.<br/>To get access to the API, developers must first subscribe to a product. When they subscribe, they get a subscription key that's good for any API in that product. <br/>If you created the API Management instance, you're an administrator already, so you're subscribed to every product in the instance.|
62
+
|**Gateways**|**Managed**|API gateway(s) that expose the API.<br/>**Managed** gateway indicates the gateway built-into the API Management service and hosted by Microsoft in Azure. Other gateways are [self-hosted gateways](self-hosted-gateway-overview.md) and are available only in the Premium and Developer service tiers. You can deploy them in Microsoft Azure, on premises, or in other clouds.<br/>If no gateways are selected, the API won't be available and your API requests won't succeed.|
62
63
|**Version this API?**|Select or deselect|For more information about versioning, see [Publish multiple versions of your API](api-management-get-started-publish-versions.md).|
63
64
64
65
> [!NOTE]
65
-
> To publish the API, you must associate it with a product. You can do that from the **Settings** page.
66
+
> To publish the API to API consumers, you must associate it with a product.
66
67
67
-
1. Select **Create**.
68
+
2. Select **Create**.
68
69
69
70
If you have problems importing an API definition, see the [list of known issues and restrictions](api-management-api-import-restrictions.md).
Copy file name to clipboardExpand all lines: articles/api-management/import-api-from-oas.md
+3-32Lines changed: 3 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,17 +11,14 @@ ms.service: api-management
11
11
ms.workload: mobile
12
12
ms.tgt_pltfrm: na
13
13
ms.topic: tutorial
14
-
ms.date: 07/12/2019
14
+
ms.date: 04/20/2020
15
15
ms.author: apimpm
16
16
17
17
---
18
18
# Import an OpenAPI specification
19
19
20
20
This article shows how to import an "OpenAPI specification" back-end API residing at https://conferenceapi.azurewebsites.net?format=json. This back-end API is provided by Microsoft and hosted on Azure. The article also shows how to test the APIM API.
21
21
22
-
> [!IMPORTANT]
23
-
> See this [document](https://azure.microsoft.com/blog/announcing-the-preview-of-openapi-specification-v3-support-in-azure-api-management/) for important information and tips related to OpenAPI import.
24
-
25
22
In this article, you learn how to:
26
23
27
24
> [!div class="checklist"]
@@ -37,42 +34,16 @@ Complete the following quickstart: [Create an Azure API Management instance](get
37
34
38
35
## <aname="create-api"> </a>Import and publish a back-end API
39
36
40
-
1.Select **APIs** from under **API MANAGEMENT**.
37
+
1.Navigate to your API Management service in the Azure portal and select **APIs** from the menu.
41
38
2. Select **OpenAPI specification** from the **Add a new API** list.
3. Enter appropriate settings. You can set all the API values during creation. Alternately, you can set some of them later by going to the **Settings** tab. <br/> If you press **tab** some (or all) of the fields get filled up with the info from the specified back-end service.
45
-
46
-
47
-
48
-
|Setting|Value|Description|
49
-
|---|---|---|
50
-
|**OpenAPI Specification**|https://conferenceapi.azurewebsites.net?format=json|References the service implementing the API. API management forwards requests to this address.|
51
-
|**Display name**|*Demo Conference API*|If you press tab after entering the service URL, APIM will fill out this field based on what is in the json. <br/>This name is displayed in the Developer portal.|
52
-
|**Name**|*demo-conference-api*|Provides a unique name for the API. <br/>If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.|
53
-
|**Description**|Provide an optional description of the API.|If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.|
54
-
|**API URL suffix**|*conference*|The suffix is appended to the base URL for the API management service. API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.|
55
-
|**URL scheme**|*HTTPS*|Determines which protocols can be used to access the API. |
56
-
|**Products**|*Unlimited*| Publish the API by associating the API with a product. To optionally add this new API to a product, type the product name. This step can be repeated multiple times to add the API to multiple products.<br/>Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the APIM instance, you are an administrator already, so you are subscribed to every product by default.<br/> By default, each API Management instance comes with two sample products: **Starter** and **Unlimited**. |
57
-
41
+
3. Enter the API settings. You can set all the API values during creation or configure them later by going to the **Settings** tab. The settings are explained in the [Import and publish your first API](import-and-publish.md#-import-and-publish-a-backend-api) tutorial.
58
42
4. Select **Create**.
59
43
60
44
> [!NOTE]
61
45
> The API import limitations are documented in [another article](api-management-api-import-restrictions.md).
62
46
63
-
## Test the new API in the Azure portal
64
-
65
-
66
-
67
-
Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.
68
-
69
-
1. Select the API you created in the previous step (from the **APIs** tab).
70
-
2. Press the **Test** tab.
71
-
3. Click on **GetSpeakers**. The page displays fields for query parameters, in this case none, and headers. One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. The key is filled in automatically.
0 commit comments