Skip to content

Commit 9c946a7

Browse files
authored
Merge pull request #207120 from dlepow/dpcustom
[APIM] Custom widget scaffold/upload
2 parents 8bc1366 + 148d1e1 commit 9c946a7

16 files changed

+303
-395
lines changed

.openpublishing.redirection.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
{
22
"redirections": [
3-
{
3+
{
44
"source_path": "articles/api-management/zone-redundancy.md",
55
"redirect_url": "/azure/availability-zones/migrate-api-mgt",
66
"redirect_document_id": false
77
},
8+
{
9+
"source_path": "articles/api-management/developer-portal-implement-widgets.md",
10+
"redirect_url": "/azure/api-management/developer-portal-extend-custom-functionality",
11+
"redirect_document_id": false
12+
},
813
{
914
"source_path": "articles/virtual-machines/linux/find-unattached-nics.md",
1015
"redirect_url": "/previous-versions/azure/virtual-machines/linux/find-unattached-nics",

articles/api-management/TOC.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -313,12 +313,18 @@
313313
items:
314314
- name: Understand the developer portal
315315
href: api-management-howto-developer-portal.md
316-
- name: Frequently asked questions
316+
- name: Frequently asked questions - developer portal
317317
href: developer-portal-faq.md
318318
- name: Automate portal deployments
319319
href: automate-portal-deployments.md
320320
- name: Migrate from deprecated to new developer portal
321321
href: developer-portal-deprecated-migration.md
322+
- name: Extend portal with custom functionality
323+
href: developer-portal-extend-custom-functionality.md
324+
- name: Contribute widgets
325+
href: developer-portal-widget-contribution-guidelines.md
326+
- name: Use community widgets
327+
href: developer-portal-use-community-widgets.md
322328
- name: Enable console OAuth support
323329
href: api-management-howto-oauth2.md
324330
- name: Integrate Application Insights
@@ -331,12 +337,6 @@
331337
href: developer-portal-self-host.md
332338
- name: Alternative approaches to self-hosting
333339
href: developer-portal-alternative-processes-self-host.md
334-
- name: Implement widgets
335-
href: developer-portal-implement-widgets.md
336-
- name: Contribute widgets
337-
href: developer-portal-widget-contribution-guidelines.md
338-
- name: Use community widgets
339-
href: developer-portal-use-community-widgets.md
340340
- name: Test self-hosted portal
341341
href: developer-portal-testing.md
342342
- name: Export APIs to the Power Platform

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,3 +205,4 @@ Learn more about the developer portal:
205205

206206
- [Azure API Management developer portal overview](api-management-howto-developer-portal.md)
207207
- [Migrate to the new developer portal](developer-portal-deprecated-migration.md) from the deprecated legacy portal.
208+
- Learn more about [customizing and extending](developer-portal-extend-custom-functionality.md) the functionality of the developer portal.

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,36 +34,32 @@ Migration to the new developer portal is described in the [dedicated documentati
3434

3535
Your API Management service includes a built-in, always up-to-date, **managed** developer portal. You can access it from the Azure portal interface.
3636

37-
Customize and style the managed portal through the built-in, drag-and-drop visual editor:
37+
[Customize and style](api-management-howto-developer-portal-customize.md) the managed portal through the built-in, drag-and-drop visual editor:
3838

3939
* Use the visual editor to modify pages, media, layouts, menus, styles, or website settings.
4040

4141
* Take advantage of built-in widgets to add text, images, buttons, and other objects that the portal supports out-of-the-box.
4242

43-
* [Add custom HTML](developer-portal-faq.md#how-do-i-add-custom-html-to-my-developer-portal) - for example, add HTML for a form or to embed a video player. The custom code is rendered in an inline frame (iframe).
44-
45-
See [this tutorial](api-management-howto-developer-portal-customize.md) for example customizations.
46-
4743
> [!NOTE]
4844
> The managed developer portal receives and applies updates automatically. Changes that you've saved but not published to the developer portal remain in that state during an update.
4945
50-
## <a name="managed-vs-self-hosted"></a> Extensibility
51-
52-
In some cases you might need functionality beyond the customization and styling options supported in the managed developer portal. If you need to implement custom logic, which isn't supported out-of-the-box, you can modify the portal's codebase, available on [GitHub](https://github.com/Azure/api-management-developer-portal). For example, you could create a new widget to integrate with a third-party support system. When you implement new functionality, you can choose one of the following options:
53-
54-
- **Self-host** the resulting portal outside of your API Management service. When you self-host the portal, you become its maintainer and you are responsible for its upgrades. Azure Support's assistance is limited only to the [basic setup of self-hosted portals](developer-portal-self-host.md).
55-
- Open a pull request for the API Management team to merge new functionality to the **managed** portal's codebase.
56-
57-
For extensibility details and instructions, refer to the [GitHub repository](https://github.com/Azure/api-management-developer-portal) and the tutorial to [implement a widget](developer-portal-implement-widgets.md). The tutorial to [customize the managed portal](api-management-howto-developer-portal-customize.md) walks you through the portal's administrative panel, which is common for **managed** and **self-hosted** versions.
46+
## <a name="managed-vs-self-hosted"></a> Options to extend portal functionality
47+
In some cases you might need functionality beyond the customization and styling options provided in the managed developer portal. If you need to implement custom logic, which isn't supported out-of-the-box, you have [several options](developer-portal-extend-custom-functionality.md):
48+
* [Add custom HTML](developer-portal-extend-custom-functionality.md#use-custom-html-code-widget) directly through a developer portal widget designed for small customizations - for example, add HTML for a form or to embed a video player. The custom code is rendered in an inline frame (iframe).
49+
* [Create and upload a custom widget](developer-portal-extend-custom-functionality.md#create-and-upload-custom-widget) to develop and add more complex custom portal features.
50+
* [Self-host the portal](developer-portal-self-host.md), only if you need to make modifications to the core of the developer portal [codebase](https://github.com/Azure/api-management-developer-portal). This option requires advanced configuration. Azure Support's assistance is limited only to the basic setup of self-hosted portals.
5851

52+
> [!NOTE]
53+
> Because the API Management developer portal codebase is maintained on [GitHub](https://github.com/Azure/api-management-developer-portal), you can open issues and make pull requests for the API Management team to merge new functionality at any time.
54+
>
5955
6056
## Next steps
6157

6258
Learn more about the developer portal:
6359

6460
- [Access and customize the managed developer portal](api-management-howto-developer-portal-customize.md)
61+
- [Extend functionality of the managed developer portal](developer-portal-extend-custom-functionality.md)
6562
- [Set up self-hosted version of the portal](developer-portal-self-host.md)
66-
- [Implement your own widget](developer-portal-implement-widgets.md)
6763

6864
Browse other resources:
6965

0 commit comments

Comments
 (0)