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/set-up-api-center-portal.md
+13-19Lines changed: 13 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,15 @@ ms.collection:
14
14
15
15
# Set up and customize your API Center portal
16
16
17
-
This article shows you how to set up and customize the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs, MCP servers, and related assets in your [API center](overview.md). Portal users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information can be configured with Microsoft Entra ID and Azure role-based access control.
17
+
This article shows you how to set up and customize the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs, MCP servers, and related assets in your [API center](overview.md).
18
+
19
+
The API Center portal supports and streamlines the work of developers who use and create APIs within your organization. Users with access can:
20
+
21
+
***Search for APIs** by name or use AI-assisted semantic search.
22
+
***Filter APIs** by type or lifecycle stage.
23
+
***View API details and definitions** including endpoints, methods, parameters, and response formats.
24
+
***Download API definitions** to a local computer or open them in Visual Studio Code.
25
+
***Try out APIs** that support API key authentication or OAuth 2.0 authorization.
18
26
19
27
:::image type="content" source="media/self-host-api-center-portal/api-center-portal-signed-in.png" alt-text="Screenshot of the API Center portal after user sign-in.":::
20
28
@@ -48,7 +56,7 @@ To set up the API Center portal with anonymous access enabled, follow these step
48
56
:::image type="content" source="media/set-up-api-center-portal/configure-access-anonymous.png" alt-text="Screenshot showing configuration of anonymous access in the portal.":::
49
57
1. To configure access, select **Confirm and Enable**.
50
58
51
-
## Access the portal
59
+
## View the portal
52
60
53
61
After configuring access, go to the API Center portal in your browser.
54
62
@@ -76,7 +84,7 @@ On the **Site profile** tab of the API Center portal settings, optionally provid
76
84
77
85
:::image type="content" source="media/set-up-api-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal.":::
78
86
79
-
## API visibility
87
+
###API visibility
80
88
81
89
On the **Visibility** tab, control which APIs are discoverable (visible) to API Center portal users. Visibility settings apply to all users of the API Center portal.
82
90
@@ -88,7 +96,7 @@ To make only specific APIs visible, add filter conditions for APIs based on buil
88
96
89
97
:::image type="content" source="media/set-up-api-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal.":::
90
98
91
-
## Semantic search
99
+
###Semantic search
92
100
93
101
If you enable semantic search on the **Semantic search** tab, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names, descriptions, and optionally custom metadata. Semantic search is available in the **Standard** plan only.
94
102
@@ -101,7 +109,7 @@ To use AI-assisted search when signed in to the API Center portal, select the se
101
109
102
110
:::image type="content" source="media/set-up-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal.":::
103
111
104
-
## Custom metadata
112
+
###Custom metadata
105
113
106
114
On the **Metadata** tab, optionally select [custom metadata](metadata.md) properties that you want to expose in API details and semantic search.
107
115
@@ -111,20 +119,6 @@ You can configure user settings to granularly authorize access to APIs and their
111
119
112
120
Access policies also apply to the "Try this API" capability for APIs in the API Center portal, ensuring that only portal users with the appropriate access policy can use the test console for those API versions. [Learn more about authorizing access to APIs](authorize-api-access.md).
113
121
114
-
## API discovery and consumption in the API Center portal
115
-
116
-
The API Center portal supports and streamlines the work of developers who use and create APIs within your organization. Signed-in users can:
117
-
118
-
***Search for APIs** by name or use [AI-assisted semantic search](customize-api-center-portal.md#semantic-search).
119
-
120
-
***Filter APIs** by type or lifecycle stage.
121
-
122
-
***View API details and definitions** including endpoints, methods, parameters, and response formats.
123
-
124
-
***Download API definitions** to a local computer or open them in Visual Studio Code.
125
-
126
-
***Try out APIs** that support API key authentication or OAuth 2.0 authorization.
0 commit comments