Skip to content

Commit 81bc9bf

Browse files
unknownunknown
authored andcommitted
APIM: revise portal docs
1 parent 0160c46 commit 81bc9bf

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

articles/api-management/api-management-howto-developer-portal-customize.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: api-management
1111
ms.workload: mobile
1212
ms.tgt_pltfrm: na
1313
ms.topic: article
14-
ms.date: 11/22/2019
14+
ms.date: 03/05/2020
1515
ms.author: apimpm
1616
---
1717

@@ -122,6 +122,10 @@ To make your portal and its latest changes available to visitors, you need to pu
122122

123123
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.
124124

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.
128+
125129
## Next steps
126130

127131
Learn more about the developer portal:

articles/api-management/api-management-howto-developer-portal.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: api-management
1212
ms.workload: mobile
1313
ms.tgt_pltfrm: na
1414
ms.topic: article
15-
ms.date: 11/22/2019
15+
ms.date: 03/05/2020
1616
ms.author: apimpm
1717
---
1818

@@ -22,10 +22,6 @@ Developer portal is an automatically generated, fully customizable website with
2222

2323
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.
2424

25-
> [!WARNING]
26-
>
27-
> [Learn how to migrate from the preview version to the generally available version](#preview-to-ga) of the developer portal.
28-
2925
![API Management developer portal](media/api-management-howto-developer-portal/cover.png)
3026

3127
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
@@ -35,7 +31,7 @@ This article describes the differences between self-hosted and managed versions
3531
You can build your developer portal in two ways:
3632

3733
- **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 portal to 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.
3935

4036
## Portal architectural concepts
4137

@@ -66,7 +62,7 @@ The portal is based on an adapted fork of the [Paperbits framework](https://pape
6662

6763
## <a name="faq"></a> Frequently asked questions
6864

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).
7066

7167
### <a id="preview-to-ga"/> How can I migrate from the preview version of the portal?
7268

@@ -82,13 +78,13 @@ If you don't want to reset the content of the portal, you may consider using new
8278

8379
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.
8480

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?
8682

8783
Portals are incompatible and you need to migrate the content manually.
8884

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?
9086

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*.
9288

9389
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).
9490

@@ -100,24 +96,26 @@ Deprecation of the legacy portals will be announced separately. If you have ques
10096

10197
### Functionality I need isn't supported in the portal
10298

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.
104100

105101
### How can I automate portal deployments?
106102

107103
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.
108104

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.
110106

111107
### Does the portal support Azure Resource Manager templates and/or is it compatible with API Management DevOps Resource Kit?
112108

113109
No.
114110

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?
116112

117113
In most cases - no.
118114

119115
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 (...)`.
120116

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+
121119
### I have assigned a custom API Management domain and the published portal doesn't work
122120

123121
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
134132

135133
Most configuration changes (for example, VNet, sign-in and product terms) require [republishing the portal](api-management-howto-developer-portal-customize.md#publish).
136134

137-
### I'm getting a CORS error when using the interactive console
135+
### <a name="cors"></a> I'm getting a CORS error when using the interactive console
138136

139137
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:
140138

@@ -166,7 +164,7 @@ The interactive console makes a client-side API request from the browser. You ca
166164
>
167165
> 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.
168166
>
169-
> The browser automatically issues an OPTIONS HTTP request, which doesnt 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 cant 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.
170168
>
171169
> As a workaround you can pass the subscription key in a query parameter.
172170

0 commit comments

Comments
 (0)