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-management/api-management-howto-developer-portal-customize.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.service: api-management
11
11
ms.workload: mobile
12
12
ms.tgt_pltfrm: na
13
13
ms.topic: article
14
-
ms.date: 11/22/2019
14
+
ms.date: 03/05/2020
15
15
ms.author: apimpm
16
16
---
17
17
@@ -122,6 +122,10 @@ To make your portal and its latest changes available to visitors, you need to pu
122
122
123
123
After you publish the portal, you can access it at the same URL as the administrative panel, for example `https://contoso-api.developer.azure-api.net`. View it in a separate browser session (incognito / private browsing mode) as an external visitor.
124
124
125
+
## Apply the CORS policy on APIs
126
+
127
+
You need to enable CORS (cross-origin resource sharing) on your APIs to let the visitors of your portal test the APIs through the built-in interactive console. Refer to [this documentation article](api-management-howto-developer-portal.md#cors) for more details.
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-developer-portal.md
+13-15Lines changed: 13 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ms.service: api-management
12
12
ms.workload: mobile
13
13
ms.tgt_pltfrm: na
14
14
ms.topic: article
15
-
ms.date: 11/22/2019
15
+
ms.date: 03/05/2020
16
16
ms.author: apimpm
17
17
---
18
18
@@ -22,10 +22,6 @@ Developer portal is an automatically generated, fully customizable website with
22
22
23
23
This article describes the differences between self-hosted and managed versions of the developer portal in API Management. It also explains its architecture and provides answers to frequently asked questions.
24
24
25
-
> [!WARNING]
26
-
>
27
-
> [Learn how to migrate from the preview version to the generally available version](#preview-to-ga) of the developer portal.
@@ -35,7 +31,7 @@ This article describes the differences between self-hosted and managed versions
35
31
You can build your developer portal in two ways:
36
32
37
33
-**Managed version** - by editing and customizing the portal, which is built into your API Management instance and is accessible through the URL `<your-api-management-instance-name>.developer.azure-api.net`. Refer to [this documentation article](api-management-howto-developer-portal-customize.md) to learn how to access and customize the managed portal.
38
-
-**Self-hosted version** - by deploying and self-hosting your portal outside of an API Management instance. This approach allows you to edit the portal's codebase and extend the provided core functionality. You also need to upgrade the portalto the latest version yourself. For details and instructions, refer to the [GitHub repository with the source code of the portal][1] and [the tutorial on implementing a widget][3]. The [tutorial for the managed version](api-management-howto-developer-portal-customize.md) walks through the portal's administrative panel, which is also featured in the self-hosted version.
34
+
-**Self-hosted version** - by deploying and self-hosting your portal outside of an API Management instance. This approach allows you to edit the portal's codebase and extend the provided core functionality - for example, implement custom widgets for integrations with third party systems. In this scenario, you are the portal's maintainer and you are responsible for upgrading the portal to the latest version. For details and instructions, refer to the [GitHub repository with the source code of the portal][1] and [the tutorial on implementing a widget][3]. The [tutorial for the managed version](api-management-howto-developer-portal-customize.md) walks through the portal's administrative panel, which is common for the managed and the self-hosted versions.
39
35
40
36
## Portal architectural concepts
41
37
@@ -66,7 +62,7 @@ The portal is based on an adapted fork of the [Paperbits framework](https://pape
66
62
67
63
## <aname="faq"></a> Frequently asked questions
68
64
69
-
In this section, we answer common questions about the new developer portal, which are of general nature. For questions specific to the self-hosted version, refer to [the wiki section of the GitHub repository](https://github.com/Azure/api-management-developer-portal/wiki).
65
+
In this section, we answer common questions about the developer portal, which are of general nature. For questions specific to the self-hosted version, refer to [the wiki section of the GitHub repository](https://github.com/Azure/api-management-developer-portal/wiki).
70
66
71
67
### <aid="preview-to-ga"/> How can I migrate from the preview version of the portal?
72
68
@@ -82,13 +78,13 @@ If you don't want to reset the content of the portal, you may consider using new
82
78
83
79
If your portal was provisioned after the general availability announcement, it should already feature the new default content. No action is required from your side.
84
80
85
-
### How can I migrate from the old developer portal to the new developer portal?
81
+
### How can I migrate from the old developer portal to the developer portal?
86
82
87
83
Portals are incompatible and you need to migrate the content manually.
88
84
89
-
### Does the new portal have all the features of the old portal?
85
+
### Does the portal have all the features of the old portal?
90
86
91
-
The new developer portal doesn't support *Applications* and *Issues*. If you have used *Issues* in the old portal and need them in the new one, post a comment in [a dedicated GitHub issue](https://github.com/Azure/api-management-developer-portal/issues/122).
87
+
The developer portal no longer supports *Applications* and *Issues*.
92
88
93
89
Authentication with OAuth in the interactive developer console is not yet supported. You can track the progress through [the GitHub issue](https://github.com/Azure/api-management-developer-portal/issues/208).
94
90
@@ -100,24 +96,26 @@ Deprecation of the legacy portals will be announced separately. If you have ques
100
96
101
97
### Functionality I need isn't supported in the portal
102
98
103
-
Use the self-hosted version and [implement your own widget][3].
99
+
You can open a [feature request](https://aka.ms/apimwish) or [implement the missing functionality yourself][3]. If you implement the functionality yourself, you can either self-host the developer portal or open a pull request on GitHub to include the changes in the managed version.
104
100
105
101
### How can I automate portal deployments?
106
102
107
103
You can programmatically access and manage the developer portal's content through the REST API, regardless if you're using a managed or a self-hosted version.
108
104
109
-
The API is documented in [the GitHub repository's wiki section][2]. It can also be used for automating migrations of portal content between environments - for example from a test environment to the production environment. You can learn more about this process [in this documentation article](https://aka.ms/apimdocs/migrateportal) on GitHub.
105
+
The API is documented in [the GitHub repository's wiki section][2]. It can be used for automating migrations of portal content between environments - for example, from a test environment to the production environment. You can learn more about this process [in this documentation article](https://aka.ms/apimdocs/migrateportal) on GitHub.
110
106
111
107
### Does the portal support Azure Resource Manager templates and/or is it compatible with API Management DevOps Resource Kit?
112
108
113
109
No.
114
110
115
-
### Do I need to enable additional VNet connectivity for the new managed portal dependencies?
111
+
### Do I need to enable additional VNet connectivity for the managed portal dependencies?
116
112
117
113
In most cases - no.
118
114
119
115
If your API Management service is in an internal VNet, your developer portal is only accessible from within the network. The management endpoint's host name must resolve to the internal VIP of the service from the machine you use to access the portal's administrative interface. Make sure the management endpoint is registered in the DNS. In case of misconfiguration, you will see an error: `Unable to start the portal. See if settings are specified correctly in the configuration (...)`.
120
116
117
+
If your API Management service is in an internal VNet and you're accessing it through Application Gateway from the Internet, make sure to enable connectivity to the developer portal and the management endpoints of API Management.
118
+
121
119
### I have assigned a custom API Management domain and the published portal doesn't work
122
120
123
121
After you update the domain, you need to [republish the portal](api-management-howto-developer-portal-customize.md#publish) for the changes to take effect.
@@ -134,7 +132,7 @@ After you set up delegation, you need to [republish the portal](api-management-h
134
132
135
133
Most configuration changes (for example, VNet, sign-in and product terms) require [republishing the portal](api-management-howto-developer-portal-customize.md#publish).
136
134
137
-
### I'm getting a CORS error when using the interactive console
135
+
### <aname="cors"></a> I'm getting a CORS error when using the interactive console
138
136
139
137
The interactive console makes a client-side API request from the browser. You can resolve the CORS problem by adding [a CORS policy](api-management-cross-domain-policies.md#CORS) on your API(s). You can specify all the parameters manually or use wildcard `*` values. For example:
140
138
@@ -166,7 +164,7 @@ The interactive console makes a client-side API request from the browser. You ca
166
164
>
167
165
> If you apply the CORS policy in the Product scope, instead of the API(s) scope, and your API uses subscription key authentication through a header, your console won't work.
168
166
>
169
-
> The browser automatically issues an OPTIONS HTTP request, which doesn’t contain a header with the subscription key. Because of the missing subscription key, API Management can't associate the OPTIONS call with a Product, so it can’t apply the CORS policy.
167
+
> The browser automatically issues an OPTIONS HTTP request, which doesn't contain a header with the subscription key. Because of the missing subscription key, API Management can't associate the OPTIONS call with a Product, so it can't apply the CORS policy.
170
168
>
171
169
> As a workaround you can pass the subscription key in a query parameter.
0 commit comments