@azure/api-management-custom-widgets-tools

Tools for working with custom widgets of Developer portal of Azure API Management service

This repository is managed by the Microsoft Azure API Management team and contains the source code of tools for development of custom widgets for the Developer portal. Refer to the official Azure documentation for more information and instructions.

Source code | Package (NPM) | Product documentation

Getting started

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge, and Firefox

Prerequisites

• An Azure Subscription
• An API Management resource
• Active Developer portal
• A project of a custom widget generated by the @azure/api-management-custom-widgets-scaffolder package

Create your first Custom widget

Navigate to Custom widgets for Developer portal documentation to learn how to create and manage Custom widgets.

Key concepts

Package provides tools for communication between scaffolded widgets and the Developer Portal

This package should not be confused with @azure/api-management-custom-widgets-scaffolder package, which contains template files and a function to generate Custom widgets for the API Management services' Developer Portal.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

To execute the tests you'll need to run:

1. rush update
2. rush build -t @azure/api-management-custom-widgets-tools
3. cd sdk\apimanagement\api-management-custom-widgets-tools
4. npm run test

View our tests folder for more details.

Related projects

• Microsoft Azure SDK for JavaScript