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

Gränssnitt

EditorData	JSON-objekt med alla data som du får från Dev Portal
PortalData	Information om widgetinstansen som tagits emot från Dev Portal

Typaliaser

DeployConfig	Valfritt alternativobjekt för att konfigurera distributionsfunktionen.
Environment	Alla möjliga körningsmiljöer
OnChange	Typ av funktionen onChange.
Secrets	Hemligheter som behövs för kommunikation med Dev-portalens serverdel och andra körningsdata
ServiceInformation	resourceId – resurs-ID för API Management-tjänsten "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint – URL med protokoll (t.ex. `https://management.azure.com`) apiVersion – valfritt att åsidosätta standardtoken (t.ex. "2019-01-01") – valfritt, ger token att använda för autentisering i stället för metoden az login
TargetModule	Möjliga målmoduler "app" för huvudprogrammet som är inbäddat i dev-portalens "redigerare" för formulär i administratörspanelen
ValuesCommon	Bas för värden obj

Funktioner

askForSecrets(TargetModule)	Begär hemligheter – token & userId, från det överordnade fönstret i Dev-portalen.
buildBlobConfigPath(string)	Generera relativ sökväg för widgetens konfiguration på bloblagringen
buildBlobDataPath(string)	Generera relativ sökväg för widgetars data i bloblagringen
buildOnChange<Values>()	Skapa onChange-funktionen, som du kan använda, för att skicka ändrade data från redigeraren.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	Distribuerar allt från /dist-mappen till API Management DevPortals bloblagring.
getEditorValues<Values>()	Funktion för att hämta värden som du har angett i administratörsredigerarens fönster.
getValues<Values>(Values)	Funktion för att hämta värden som du har angett i administratörsredigerarens fönster. Odefinierade/tomma värden ersätts med standardvärden.
getWidgetData<Values>()	Funktion för att hämta alla data som är relaterade till widgeten, inklusive tekniska värden som inte förväntas behövas i de flesta fall. API:et är främst avsett för intern användning och kan ändras. Överväg att använda getValues eller getEditorValues i stället.
onChangeWithOrigin<Values>(string, string, Values)	Själva funktionen onChange med "origin" tillhandahålls som en param.

Variabler

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Nyckeln för ett postmeddelandeobjekt används för att begära och skicka hemligheter – token och användar-id – från DevPortal. Används för att förhindra störningar med andra tillämpningar.
APIM_CONFIG_FILE_NAME	Namnet på konfigurationsfilen
APIM_EDITOR_DATA_KEY	Nyckel för en sökparameter, från vilken editordata laddas.
APIM_ON_CHANGE_MESSAGE_KEY	Nyckeln till ett postmeddelandeobjekt används för att sprida ändringar från editorn till DevPortal. Används för att förhindra störningar med andra tillämpningar.
BLOB_CONFIGS_FOLDER	Namn på blob-lagringsmappen med widgetkonfigurationer
BLOB_DATA_FOLDER	Namn på blob-lagringsmappen med widget-implementering
BLOB_ROOT	roten till blob storage-mappen

Funktionsdetaljer

askForSecrets(TargetModule)

Begär hemligheter – token & userId, från det överordnade fönstret i Dev-portalen.

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

Parametrar

targetModule: TargetModule

anropas funktionen från huvudfönstret "app" eller administratörens "redigerare"?

Returnerar

Promise<Secrets>

buildBlobConfigPath(string)

Generera relativ sökväg för widgetens konfiguration på bloblagringen

function buildBlobConfigPath(name: string): string

Parametrar

name: string

namnet på widgeten

Returnerar

string

buildBlobDataPath(string)

Generera relativ sökväg för widgetars data i bloblagringen

function buildBlobDataPath(name: string): string

Parametrar

name: string

namnet på widgeten

Returnerar

string

buildOnChange<Values>()

Skapa onChange-funktionen, som du kan använda, för att skicka ändrade data från redigeraren.

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

Returnerar

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

Distribuerar allt från /dist-mappen till API Management DevPortals bloblagring.

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

Parametrar

serviceInformation: ServiceInformation

tjänstinformation för distribution

name: string

namnet på widgeten som ska distribueras

fallbackConfigPath: string

lokal sökväg till konfigurationsfilen (som standard "./static/config.msapim.json")

config: DeployConfig

valfritt konfigurationsobjekt

Returnerar

Promise<void>

getEditorValues<Values>()

Funktion för att hämta värden som du har angett i administratörsredigerarens fönster.

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

Returnerar

Partial<Values>

getValues<Values>(Values)

Funktion för att hämta värden som du har angett i administratörsredigerarens fönster. Odefinierade/tomma värden ersätts med standardvärden.

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

Parametrar

valuesDefault: Values

objekt med standardvärden som ska användas, importera bara värdenFelobjekt från values.ts mapp

Returnerar

Values

getWidgetData<Values>()

Funktion för att hämta alla data som är relaterade till widgeten, inklusive tekniska värden som inte förväntas behövas i de flesta fall. API:et är främst avsett för intern användning och kan ändras. Överväg att använda getValues eller getEditorValues i stället.

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

Returnerar

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

Själva funktionen onChange med "origin" tillhandahålls som en param.

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

Parametrar

origin: string

webbinnehållets ursprung (URL) för dev-portalen för att skicka ändringar till

instanceId: string

ID för den här specifika instansen av widgeten

values: Values

värden som har ändrats

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Nyckeln för ett postmeddelandeobjekt används för att begära och skicka hemligheter – token och användar-id – från DevPortal. Används för att förhindra störningar med andra tillämpningar.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Typ

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

Namnet på konfigurationsfilen

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Typ

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Nyckel för en sökparameter, från vilken editordata laddas.

APIM_EDITOR_DATA_KEY: "editorData"

Typ

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Nyckeln till ett postmeddelandeobjekt används för att sprida ändringar från editorn till DevPortal. Används för att förhindra störningar med andra tillämpningar.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Typ

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Namn på blob-lagringsmappen med widgetkonfigurationer

BLOB_CONFIGS_FOLDER: "configs"

Typ

"configs"

BLOB_DATA_FOLDER

Namn på blob-lagringsmappen med widget-implementering

BLOB_DATA_FOLDER: "data"

Typ

"data"

BLOB_ROOT

roten till blob storage-mappen

BLOB_ROOT: "custom-widgets"

Typ

"custom-widgets"

Feedback

Var den här sidan till hjälp?