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

Schnittstellen

EditorData	JSON-Objekt mit allen Daten, die Sie vom Dev Portal erhalten
PortalData	Informationen zur Widgetinstanz, die vom Dev Portal empfangen wurde

Typaliase

DeployConfig	Optionales Optionsobjekt zum Konfigurieren der Bereitstellungsfunktion.
Environment	Alle möglichen Laufzeitumgebungen
OnChange	Typ der onChange-Funktion.
Secrets	Geheime Schlüssel für die Kommunikation mit Dev Portal-Back-End- und anderen Laufzeitdaten
ServiceInformation	resourceId - Ressourcen-ID des API-Verwaltungsdiensts "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint - URL mit Protokoll (z. B. `https://management.azure.com`) apiVersion – optional zum Außerkraftsetzen des Standardwerts (z. B. "2019-01-01") tokenOverride – optional, stellt Token bereit, das für die Authentifizierung verwendet werden soll, anstelle des "az login"-Ansatzes.
TargetModule	Mögliche Zielmodule "App" für die Hauptanwendung, die in Ihrem Dev Portal "Editor" für das Formular im Admin Panel eingebettet ist
ValuesCommon	Basis eines Werte-Obj

Functions

askForSecrets(TargetModule)	Anfordern geheimer Schlüssel – Token & userId aus dem übergeordneten Fenster des Dev-Portals.
buildBlobConfigPath(string)	Relativer Pfad für die Konfiguration von Widgets im BLOB-Speicher generieren
buildBlobDataPath(string)	Generieren eines relativen Pfads für widgets-Daten im Blobspeicher
buildOnChange<Values>()	Erstellen Sie die OnChange-Funktion, die Sie verwenden können, um geänderte Daten aus dem Editor zu senden.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	Stellt alles aus dem Ordner "/dist" im BLOB-Speicher der API-Verwaltung von DevPortals bereit.
getEditorValues<Values>()	Funktion zum Abrufen von Werten, die Sie im Administrator-Editor-Fenster festgelegt haben.
getValues<Values>(Values)	Funktion zum Abrufen von Werten, die Sie im Administrator-Editor-Fenster festgelegt haben. Nicht definierte/leere Werte werden durch Standardwerte ersetzt.
getWidgetData<Values>()	Funktion zum Abrufen aller Daten im Zusammenhang mit dem Widget, einschließlich technischer Werte, die in den meisten Fällen nicht benötigt werden. Die API ist hauptsächlich für die interne Verwendung vorgesehen, kann sich ändern. Erwägen Sie stattdessen die Verwendung von "getValues" oder "getEditorValues".
onChangeWithOrigin<Values>(string, string, Values)	Die onChange-Funktion selbst mit "origin", die als Param bereitgestellt wird.

Variablen

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Der Schlüssel für ein Post-Message-Objekt wird verwendet, um Geheimnisse – Token und Benutzer-ID – vom DevPortal anzufordern und zu senden. Wird verwendet, um Störungen mit anderen Anwendungen zu verhindern.
APIM_CONFIG_FILE_NAME	Name der Konfigurationsdatei
APIM_EDITOR_DATA_KEY	Tast für ein Suchparameter, von dem aus die Editor-Daten geladen werden.
APIM_ON_CHANGE_MESSAGE_KEY	Key für ein Post-Message-Objekt wird verwendet, um Änderungen vom Editor ins DevPortal zu übertragen. Wird verwendet, um Störungen mit anderen Anwendungen zu verhindern.
BLOB_CONFIGS_FOLDER	Name des Blob-Speicherordners mit Widget-Konfigurationen
BLOB_DATA_FOLDER	Name des Blob-Speicherordners mit Widget-Implementierung
BLOB_ROOT	Wurzel des Blob-Speicherordners

Details zur Funktion

askForSecrets(TargetModule)

Anfordern geheimer Schlüssel – Token & userId aus dem übergeordneten Fenster des Dev-Portals.

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

Parameter

targetModule: TargetModule

wird die Funktion aus dem Hauptfenster "App" oder dem Administrator "Editor" aufgerufen?

Gibt zurück

Promise<Secrets>

buildBlobConfigPath(string)

Relativer Pfad für die Konfiguration von Widgets im BLOB-Speicher generieren

function buildBlobConfigPath(name: string): string

Parameter

name: string

Name des Widgets

Gibt zurück

string

buildBlobDataPath(string)

Generieren eines relativen Pfads für widgets-Daten im Blobspeicher

function buildBlobDataPath(name: string): string

Parameter

name: string

Name des Widgets

Gibt zurück

string

buildOnChange<Values>()

Erstellen Sie die OnChange-Funktion, die Sie verwenden können, um geänderte Daten aus dem Editor zu senden.

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

Gibt zurück

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

Stellt alles aus dem Ordner "/dist" im BLOB-Speicher der API-Verwaltung von DevPortals bereit.

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

Parameter

serviceInformation: ServiceInformation

Dienstinformationen für die Bereitstellung

name: string

Name des zu bereitstellenden Widgets

fallbackConfigPath: string

lokaler Pfad zur Konfigurationsdatei (standardmäßig "./static/config.msapim.json")

config: DeployConfig

optionales Config-Objekt

Gibt zurück

Promise<void>

getEditorValues<Values>()

Funktion zum Abrufen von Werten, die Sie im Administrator-Editor-Fenster festgelegt haben.

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

Gibt zurück

Partial<Values>

getValues<Values>(Values)

Funktion zum Abrufen von Werten, die Sie im Administrator-Editor-Fenster festgelegt haben. Nicht definierte/leere Werte werden durch Standardwerte ersetzt.

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

Parameter

valuesDefault: Values

-Objekt mit den zu verwendenden Standardwerten importieren Sie einfach "valuesDefault"-Objekt aus values.ts Ordner.

Gibt zurück

Values

getWidgetData<Values>()

Funktion zum Abrufen aller Daten im Zusammenhang mit dem Widget, einschließlich technischer Werte, die in den meisten Fällen nicht benötigt werden. Die API ist hauptsächlich für die interne Verwendung vorgesehen, kann sich ändern. Erwägen Sie stattdessen die Verwendung von "getValues" oder "getEditorValues".

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

Gibt zurück

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

Die onChange-Funktion selbst mit "origin", die als Param bereitgestellt wird.

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

Parameter

origin: string

Ursprung (URL) von Webinhalten ihres Dev-Portals zum Senden von Änderungen an

instanceId: string

ID dieser bestimmten Instanz des Widgets

values: Values

geänderte Werte

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Der Schlüssel für ein Post-Message-Objekt wird verwendet, um Geheimnisse – Token und Benutzer-ID – vom DevPortal anzufordern und zu senden. Wird verwendet, um Störungen mit anderen Anwendungen zu verhindern.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Typ

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

Name der Konfigurationsdatei

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Typ

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Tast für ein Suchparameter, von dem aus die Editor-Daten geladen werden.

APIM_EDITOR_DATA_KEY: "editorData"

Typ

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Key für ein Post-Message-Objekt wird verwendet, um Änderungen vom Editor ins DevPortal zu übertragen. Wird verwendet, um Störungen mit anderen Anwendungen zu verhindern.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Typ

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Name des Blob-Speicherordners mit Widget-Konfigurationen

BLOB_CONFIGS_FOLDER: "configs"

Typ

"configs"

BLOB_DATA_FOLDER

Name des Blob-Speicherordners mit Widget-Implementierung

BLOB_DATA_FOLDER: "data"

Typ

"data"

BLOB_ROOT

Wurzel des Blob-Speicherordners

BLOB_ROOT: "custom-widgets"

Typ

"custom-widgets"

Feedback

War diese Seite hilfreich?