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

Interfejsów

EditorData	Obiekt JSON ze wszystkimi danymi otrzymanymi z portalu deweloperskiego
PortalData	Informacje o wystąpieniu widżetu odebrane z portalu deweloperskiego

Aliasy typu

DeployConfig	Obiekt opcji opcjonalnych do konfigurowania funkcji wdrażania.
Environment	Wszystkie możliwe środowiska uruchomieniowe
OnChange	Typ funkcji onChange.
Secrets	Wpisy tajne potrzebne do komunikacji z zapleczem witryny Dev Portal i innymi danymi środowiska uruchomieniowego
ServiceInformation	resourceId — identyfikator zasobu usługi API Management "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint — adres URL z protokołem (np. `https://management.azure.com`) apiVersion — opcjonalnie, aby zastąpić wartość domyślną (np. "2019-01-01") tokenOverride — opcjonalnie, udostępnia token do użycia do uwierzytelniania, zamiast podejścia "az login"
TargetModule	Możliwe moduły docelowe "app" dla głównej aplikacji, która jest osadzona w portalu deweloperskim "editor" dla formularza w panelu administracyjnym
ValuesCommon	Podstawa wartości obj

Functions

askForSecrets(TargetModule)	Żądania wpisów tajnych — token & userId w oknie nadrzędnym portalu deweloperskiego.
buildBlobConfigPath(string)	Generowanie ścieżki względnej dla konfiguracji widżetów w magazynie obiektów blob
buildBlobDataPath(string)	Generowanie ścieżki względnej dla danych widżetów w magazynie obiektów blob
buildOnChange<Values>()	Utwórz funkcję onChange, której można użyć, aby wysyłać zmienione dane z edytora.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	Wdraża wszystko, od folderu /dist do magazynu obiektów blob usługi API Management DevPortals.
getEditorValues<Values>()	Funkcja umożliwiająca uzyskanie wartości ustawionych w oknie edytora administracyjnego.
getValues<Values>(Values)	Funkcja umożliwiająca uzyskanie wartości ustawionych w oknie edytora administracyjnego. Wartości niezdefiniowane/puste są zastępowane wartościami domyślnymi.
getWidgetData<Values>()	Funkcja umożliwiająca pobranie wszystkich danych związanych z widżetem, w tym wartości technicznych, które nie powinny być potrzebne w większości przypadków. Przeznaczony głównie do użytku wewnętrznego, interfejs API może ulec zmianie. Rozważ użycie metod getValues lub getEditorValues.
onChangeWithOrigin<Values>(string, string, Values)	Funkcja onChange jest funkcją "origin" podaną jako param.

Zmiennych

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Klucz do postmessage obiektu, służy do żądania i wysyłania sekretów – tokena i identyfikatora użytkownika – z DevPortal. Używany do zapobiegania zakłóceniom innych zastosowań.
APIM_CONFIG_FILE_NAME	Nazwa pliku konfiguracyjnego
APIM_EDITOR_DATA_KEY	Klucz do parametru wyszukiwania, z którego będą ładowane dane edytora.
APIM_ON_CHANGE_MESSAGE_KEY	Kluczowy dla postmessage obiektu, służy do propagowania zmian z edytora do DevPortal. Używany do zapobiegania zakłóceniom innych zastosowań.
BLOB_CONFIGS_FOLDER	Nazwa folderu pamięci blob z konfiguracjami widżetów
BLOB_DATA_FOLDER	Nazwa folderu pamięci blob z implementacją widgetów
BLOB_ROOT	Root folderu pamięci blob

Szczegóły funkcji

askForSecrets(TargetModule)

Żądania wpisów tajnych — token & userId w oknie nadrzędnym portalu deweloperskiego.

function askForSecrets(targetModule: TargetModule): Promise<Secrets>

Parametry

targetModule: TargetModule

czy funkcja jest wywoływana z głównego okna "app" lub administratora "editor"?

Zwraca

Promise<Secrets>

buildBlobConfigPath(string)

Generowanie ścieżki względnej dla konfiguracji widżetów w magazynie obiektów blob

function buildBlobConfigPath(name: string): string

Parametry

name: string

nazwa widżetu

Zwraca

string

buildBlobDataPath(string)

Generowanie ścieżki względnej dla danych widżetów w magazynie obiektów blob

function buildBlobDataPath(name: string): string

Parametry

name: string

nazwa widżetu

Zwraca

string

buildOnChange<Values>()

Utwórz funkcję onChange, której można użyć, aby wysyłać zmienione dane z edytora.

function buildOnChange<Values>(): OnChange<Values>

Zwraca

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

Wdraża wszystko, od folderu /dist do magazynu obiektów blob usługi API Management DevPortals.

function deployNodeJS(serviceInformation: ServiceInformation, name: string, fallbackConfigPath?: string, config?: DeployConfig): Promise<void>

Parametry

serviceInformation: ServiceInformation

informacje o usłudze na potrzeby wdrożenia

name: string

nazwa widżetu, który ma zostać wdrożony

fallbackConfigPath: string

ścieżka lokalna do pliku konfiguracji (domyślnie "./static/config.msapim.json")

config: DeployConfig

opcjonalny obiekt konfiguracji

Zwraca

Promise<void>

getEditorValues<Values>()

Funkcja umożliwiająca uzyskanie wartości ustawionych w oknie edytora administracyjnego.

function getEditorValues<Values>(): Partial<Values>

Zwraca

Partial<Values>

getValues<Values>(Values)

Funkcja umożliwiająca uzyskanie wartości ustawionych w oknie edytora administracyjnego. Wartości niezdefiniowane/puste są zastępowane wartościami domyślnymi.

function getValues<Values>(valuesDefault: Values): Values

Parametry

valuesDefault: Values

obiekt z wartościami domyślnymi do użycia, po prostu zaimportuj obiektdefault z folderu values.ts

Zwraca

Values

getWidgetData<Values>()

Funkcja umożliwiająca pobranie wszystkich danych związanych z widżetem, w tym wartości technicznych, które nie powinny być potrzebne w większości przypadków. Przeznaczony głównie do użytku wewnętrznego, interfejs API może ulec zmianie. Rozważ użycie metod getValues lub getEditorValues.

function getWidgetData<Values>(): EditorData<Values>

Zwraca

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

Funkcja onChange jest funkcją "origin" podaną jako param.

function onChangeWithOrigin<Values>(origin: string, instanceId: string, values: Values)

Parametry

origin: string

źródło zawartości internetowej (adres URL) portalu deweloperskiego w celu wysyłania zmian do

instanceId: string

Identyfikator tego konkretnego wystąpienia widżetu

values: Values

wartości, które uległy zmianie

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Klucz do postmessage obiektu, służy do żądania i wysyłania sekretów – tokena i identyfikatora użytkownika – z DevPortal. Używany do zapobiegania zakłóceniom innych zastosowań.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Typ

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

Nazwa pliku konfiguracyjnego

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Typ

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Klucz do parametru wyszukiwania, z którego będą ładowane dane edytora.

APIM_EDITOR_DATA_KEY: "editorData"

Typ

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Kluczowy dla postmessage obiektu, służy do propagowania zmian z edytora do DevPortal. Używany do zapobiegania zakłóceniom innych zastosowań.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Typ

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Nazwa folderu pamięci blob z konfiguracjami widżetów

BLOB_CONFIGS_FOLDER: "configs"

Typ

"configs"

BLOB_DATA_FOLDER

Nazwa folderu pamięci blob z implementacją widgetów

BLOB_DATA_FOLDER: "data"

Typ

"data"

BLOB_ROOT

Root folderu pamięci blob

BLOB_ROOT: "custom-widgets"

Typ

"custom-widgets"

Opinia

Czy ta strona była pomocna?