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
Copy file name to clipboardExpand all lines: articles/api-center/enable-platform-api-catalog-vscode-extension.md
+36-31Lines changed: 36 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
title: Enable Azure API Center data view - Visual Studio Code extension
3
-
description: Enable developers to view API data including API definitions using the Visual Studio Code Extension for Azure API Center.
2
+
title: Enable platform API catalog - Azure API Center - VS Code extension
3
+
description: Enable enterprise developers to view the enterprise's platform API catalog including API definitions using the Visual Studio Code Extension for Azure API Center.
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 09/10/2024
7
+
ms.date: 09/23/2024
8
8
ms.author: danlep
9
9
ms.custom:
10
-
# Customer intent: As an API program manager, I want to enable an extension in Visual Studio Code so that developers in my organization to discover the APIs in my organization's API center without access to Azure to manage the API center.
10
+
# Customer intent: As an API program manager, I want to enable an API catalog so that app developers in my organization can discover and consume the APIs in my organization's API center without needing to manage the API inventory itself.
11
11
---
12
12
13
-
# Enable access to Azure API Center data - Visual Studio Code extension
13
+
# Enable access to Azure API Center platform API catalog
14
14
15
-
This article shows how to enable access to the API Center data view (preview) in the Visual Studio Code extension for [Azure API Center](overview.md). Using the data view, developers can discover APIs in your Azure API center, view API definitions, and optionally generate API clients when they don't have access to manage the API center itself. Access to the data view is managed using Microsoft Entra ID and Azure role-based access control.
15
+
This article shows how to provide enterprise developers access to the Azure API Center platform API catalog (preview) in the Visual Studio Code extension for [Azure API Center](overview.md). Using the platform API catalog, developers can discover APIs in your Azure API center, view API definitions, and optionally generate API clients when they don't have access to manage the API center itself or add APIs to the inventory. Access to the platform API catalog is managed using Microsoft Entra ID and Azure role-based access control.
16
16
17
17
## Prerequisites
18
18
@@ -22,28 +22,28 @@ This article shows how to enable access to the API Center data view (preview) in
22
22
23
23
*[Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
24
24
25
-
> [!NOTE]
26
-
> Currently, access to the API Center data view is available only in the extension's pre-release version. When installing the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a pre-release version. Switch between the two versions at any time by using the extension's **Manage** button context menu in the Extensions view.
27
-
25
+
> [!IMPORTANT]
26
+
> Currently, access to the platform API catalog is available only in the extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](includes/vscode-extension-prerelease-features.md)]
27
+
28
28
The following Visual Studio Code extension is optional:
29
29
30
30
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
31
31
32
32
## Create Microsoft Entra app registration
33
33
34
-
First, configure an app registration in your Microsoft Entra ID tenant. The app registration enables the Visual Studio Code extension for Azure API Center to access data from your API center on behalf of a signed-in user.
34
+
First, configure an app registration in your Microsoft Entra ID tenant. The app registration enables the Visual Studio Code extension for Azure API Center to access the platform API catalog on behalf of a signed-in user.
35
35
36
36
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
37
37
1. Select **+ New registration**.
38
38
1. On the **Register an application** page, set the values as follows:
39
39
40
-
* Set **Name** to a meaningful name such as *api-center-data*
40
+
* Set **Name** to a meaningful name such as *platform-api-catalog*
41
41
* Under **Supported account types**, select **Accounts in this organizational directory (Single tenant)**.
42
-
* In **Redirect URI**, select **Single-page application (SPA)** and set the URI to the runtime URI of your API center. For example, `https://<service name>.data.<region>.azure-apicenter.ms`.
42
+
* In **Redirect URI**, select **Single-page application (SPA)** and set the URI to the runtime URI of your API center. For example, `https://<service name>.data.<region>.azure-apicenter.ms`. Example: `https://contoso-apic.data.eastus.azure-apicenter.ms`.
43
43
* Select **Register**.
44
44
45
45
> [!TIP]
46
-
> You can use the same app registration for access to more API centers. In **Redirect URI**, continue to add redirect URIs for other API centers that you want to appear in the data view.
46
+
> You can use the same app registration for access to more API centers. In **Redirect URI**, continue to add redirect URIs for other API centers that you want to appear in the platform API catalog.
47
47
1. On the **Overview** page, copy the **Application (client) ID** and the **Directory (tenant) ID**. You set these values later when you connect to the API center from the Visual Studio Code extension.
48
48
1. In the left menu, under **Manage**, select **Authentication** > **+ Add a platform**.
49
49
1. On the **Configure platforms** page, select **Mobile and desktop applications**.
@@ -60,14 +60,14 @@ First, configure an app registration in your Microsoft Entra ID tenant. The app
60
60
61
61
The Azure API Center permissions appear under **Configured permissions**.
62
62
63
-
:::image type="content" source="media/enable-data-view-vscode-extension/configure-app-permissions.png" alt-text="Screenshot of required permissions in Microsoft Entra ID app registration in the portal." :::
63
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/configure-app-permissions.png" alt-text="Screenshot of required permissions in Microsoft Entra ID app registration in the portal." :::
64
64
65
-
## Enable sign-in to data view by Microsoft Entra users and groups
65
+
## Enable sign-in to platform API catalog by Microsoft Entra users and groups
66
66
67
-
Users must sign in to see the data view for your API center. To enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
67
+
Developers in the enterprise must sign in to see the platform API catalog for your API center. To enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
68
68
69
69
> [!IMPORTANT]
70
-
> By default, you and other administrators of the API center don't have access to APIs in the API Center extension's data view. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
70
+
> By default, you and other administrators of the API center don't have access to APIs in the API Center extension's platform API catalog. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
71
71
72
72
For detailed prerequisites and steps to assign a role to users and groups, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml). Brief steps follow:
73
73
@@ -78,40 +78,45 @@ For detailed prerequisites and steps to assign a role to users and groups, see [
78
78
* On the **Members** page, In **Assign access to**, select **User, group, or service principal** > **+ Select members**.
79
79
* On the **Select members** page, search for and select the users or groups to assign the role to. Click **Select** and then **Next**.
80
80
* Review the role assignment, and select **Review + assign**.
81
-
1. Repeat the preceding steps to enable sign-in to the data view for more API centers.
81
+
1. Repeat the preceding steps to enable sign-in to the platform API catalog for more API centers.
82
82
83
83
> [!NOTE]
84
84
> To streamline access configuration for new users, we recommend that you assign the role to a Microsoft Entra group and configure a dynamic group membership rule. To learn more, see [Create or update a dynamic group in Microsoft Entra ID](/entra/identity/users/groups-create-rule).
85
85
86
-
## Connect to an API center
86
+
## Steps for developers to connect to an API center
87
+
88
+
Developers in the enterprise can follow these steps to connect and sign in to an API center from the Visual Studio code extension.
87
89
88
-
Developers can follow these steps to connect to an API center from the Visual Studio code extension and sign in to view the APIs.
90
+
1. Install the pre-release version of the [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center) for Visual Studio Code.
89
91
90
92
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
93
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
94
+
91
95
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Connect to an API Center** and hit **Enter**.
92
96
1. Answer the prompts to input the following information:
93
-
1. The runtime URL of your API center. Example: `<service name>.data.<region>.azure-apicenter.ms`
97
+
1. The runtime URL of your API center, in the format `<service name>.data.<region>.azure-apicenter.ms` (don't prefix with `https://`). Example: `contoso-apic.data.eastus.azure-apicenter.ms`.
94
98
1. The application (client) ID from the app registration configured in the previous section.
95
99
1. The directory (tenant) ID from the app registration configured in the previous section.
96
100
97
101
> [!TIP]
98
-
> An API center administrator needs to provide the connection settings to developers, or provide a direct link for developers to access an API center's data view. The link is in the following format:
102
+
> An API center administrator needs to provide these connection settings to developers, or provide a direct link in the following format:
After you connect to the API center, the API center appears in the API Center data view.
105
+
After you connect to the API center, the API center appears in the API Center platform API catalog.
102
106
103
-
1. To view the APIs in the API center, select **Sign in to Azure**. Sign in with a Microsoft account that is assigned the **Azure API Center Data Reader** role in the API center.
107
+
1. To view the APIs in the API center, under the API center name, select **Sign in to Azure**. Sign-in is allowed with a Microsoft account that is assigned the **Azure API Center Data Reader** role in the API center.
104
108
105
-
:::image type="content" source="media/enable-data-view-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center Data View in VS Code extension." :::
109
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center platform API catalog in VS Code extension." :::
106
110
107
111
1. After signing in, select **APIs** to list the APIs in the API center. Expand an API to explore its versions and definitions.
108
112
109
-
:::image type="content" source="media/enable-data-view-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center Data View with APIs in VS Code extension." :::
110
-
1. Repeat the preceding steps to connect to more API centers for which you have access.
113
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center platform API catalog with APIs in VS Code extension." :::
114
+
115
+
1. Repeat the preceding steps to connect to more API centers, if access is configured.
111
116
112
117
## Discover and consume APIs
113
118
114
-
The Azure API Center data view helps developers discover API details and start API client development. Right-click on an API definition in the data view to access these features:
119
+
The Azure API Center platform API catalog helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the platform API catalog:
115
120
116
121
***Export API specification document** - Export an API specification from a definition and then download it as a file
117
122
***Generate API client** - Use the Microsoft Kiota extension to generate an API client for their favorite language
@@ -123,16 +128,16 @@ The Azure API Center data view helps developers discover API details and start A
123
128
124
129
### Error: Cannot read properties of undefined (reading 'nextLink')
125
130
126
-
Under certain conditions, a user might encounter the following error message after signing into the API Center data view and expanding the APIs list for an API center:
131
+
Under certain conditions, a user might encounter the following error message after signing into the API Center platform API catalog and expanding the APIs list for an API center:
127
132
128
133
`Error: Cannot read properties of undefined (reading 'nextLink')`
129
134
`
130
135
131
-
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center data view in the Visual Studio Code extension.
136
+
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center platform API catalog in the Visual Studio Code extension.
132
137
133
138
### Unable to sign in to Azure
134
139
135
-
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the data view, there might be a problem with the configuration of the connection.
140
+
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the platform API catalog, there might be a problem with the configuration of the connection.
136
141
137
142
Check the settings in the app registration you configured in Microsoft Entra ID. Confirm the values of the application (client) ID and the directory (tenant) ID in the app registration and the runtime URL of the API center. Then, set up the connection to the API center again.
When installing the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a pre-release version. Switch between the two versions at any time by using the extension's **Manage** button context menu in the Extensions view.
0 commit comments