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

الواجهات

EditorData	كائن JSON مع جميع البيانات التي ستتلقاها من مدخل التطوير
PortalData	معلومات حول مثيل عنصر واجهة المستخدم الذي تم تلقيه من مدخل التطوير

النوع أسماء مستعارة

DeployConfig	عنصر الخيارات الاختيارية لتكوين دالة النشر.
Environment	جميع بيئات وقت التشغيل المحتملة
OnChange	نوع الدالة onChange.
Secrets	البيانات السرية اللازمة للاتصال مع الواجهة الخلفية لمدخل التطوير وبيانات وقت التشغيل الأخرى
ServiceInformation	resourceId - معرف المورد لخدمة APIM "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint - URL مع البروتوكول (على سبيل المثال. `https://management.azure.com`) apiVersion - اختياري لتجاوز الافتراضي (على سبيل المثال، "2019-01-01") tokenOverride - اختياري، يوفر رمزا مميزا لاستخدامه للمصادقة، بدلا من نهج "تسجيل الدخول إلى az"
TargetModule	الوحدات المستهدفة المحتملة "التطبيق" للتطبيق الرئيسي المضمن في "محرر" مدخل التطوير الخاص بك للنموذج في لوحة المسؤول
ValuesCommon	قاعدة قيم obj

الوظائف

askForSecrets(TargetModule)	طلب البيانات السرية - الرمز المميز & userId، من النافذة الأصل لمدخل Dev.
buildBlobConfigPath(string)	إنشاء مسار نسبي لتكوين عناصر واجهة المستخدم على تخزين الكائن الثنائي كبير الحجم
buildBlobDataPath(string)	إنشاء مسار نسبي لبيانات عناصر واجهة المستخدم على تخزين الكائن الثنائي كبير الحجم
buildOnChange<Values>()	بناء وظيفة onChange، التي يمكنك استخدامها، لإرسال البيانات التي تم تغييرها من المحرر.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	نشر كل شيء من المجلد /dist إلى تخزين الكائن الثنائي كبير الحجم ل API Management DevPortals.
getEditorValues<Values>()	دالة للحصول على القيم التي قمت بتعيينها في نافذة محرر المسؤول.
getValues<Values>(Values)	دالة للحصول على القيم التي قمت بتعيينها في نافذة محرر المسؤول. يتم استبدال القيم غير المعرفة/الفارغة بالقيم الافتراضية.
getWidgetData<Values>()	دالة للحصول على جميع البيانات المتعلقة بأداة بما في ذلك القيم التقنية التي لا يتوقع أن تكون هناك حاجة إليها في معظم الحالات. قد تتغير واجهة برمجة التطبيقات المخصصة للاستخدام الداخلي في الغالب. ضع في اعتبارك استخدام getValues أو getEditorValues بدلا من ذلك.
onChangeWithOrigin<Values>(string, string, Values)	الدالة onChange نفسها مع "الأصل" المقدمة كبارام.

المتغيرات

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	مفتاح كائن رسالة النشر، يستخدم لطلب وإرسال الأسرار - الرمز ومعرف المستخدم، من بوابة المطورين. يستخدم لمنع التداخل مع تطبيقات أخرى.
APIM_CONFIG_FILE_NAME	اسم ملف التكوين
APIM_EDITOR_DATA_KEY	مفتاح لتعديل البحث، حيث سيتم تحميل بيانات المحرر.
APIM_ON_CHANGE_MESSAGE_KEY	مفتاح كائن رسالة النشر، يستخدم لنقل التغييرات من المحرر إلى بوابة التطور. يستخدم لمنع التداخل مع تطبيقات أخرى.
BLOB_CONFIGS_FOLDER	اسم مجلد تخزين الكتلة مع إعدادات الويدجت
BLOB_DATA_FOLDER	اسم مجلد تخزين الكتلة مع تنفيذ الويدجت
BLOB_ROOT	جذر مجلد تخزين الكتلة

تفاصيل الوظيفة

askForSecrets(TargetModule)

طلب البيانات السرية - الرمز المميز & userId، من النافذة الأصل لمدخل Dev.

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

المعلمات

targetModule: TargetModule

هل يتم استدعاء الدالة من نافذة "التطبيق" الرئيسية أو "المحرر" المسؤول؟

المرتجعات

Promise<Secrets>

buildBlobConfigPath(string)

إنشاء مسار نسبي لتكوين عناصر واجهة المستخدم على تخزين الكائن الثنائي كبير الحجم

function buildBlobConfigPath(name: string): string

المعلمات

name: string

اسم عنصر واجهة المستخدم

المرتجعات

string

buildBlobDataPath(string)

إنشاء مسار نسبي لبيانات عناصر واجهة المستخدم على تخزين الكائن الثنائي كبير الحجم

function buildBlobDataPath(name: string): string

المعلمات

name: string

اسم عنصر واجهة المستخدم

المرتجعات

string

buildOnChange<Values>()

بناء وظيفة onChange، التي يمكنك استخدامها، لإرسال البيانات التي تم تغييرها من المحرر.

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

المرتجعات

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

نشر كل شيء من المجلد /dist إلى تخزين الكائن الثنائي كبير الحجم ل API Management DevPortals.

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

المعلمات

serviceInformation: ServiceInformation

معلومات الخدمة للنشر

name: string

اسم عنصر واجهة المستخدم الذي سيتم نشره

fallbackConfigPath: string

المسار المحلي إلى ملف التكوين (بشكل افتراضي "./static/config.msapim.json")

config: DeployConfig

عنصر تكوين اختياري

المرتجعات

Promise<void>

getEditorValues<Values>()

دالة للحصول على القيم التي قمت بتعيينها في نافذة محرر المسؤول.

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

المرتجعات

Partial<Values>

getValues<Values>(Values)

دالة للحصول على القيم التي قمت بتعيينها في نافذة محرر المسؤول. يتم استبدال القيم غير المعرفة/الفارغة بالقيم الافتراضية.

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

المعلمات

valuesDefault: Values

كائن بقيمك الافتراضية لاستخدامه، ما عليك سوى استيراد القيمعنصر افتراضي من مجلد values.ts

المرتجعات

Values

getWidgetData<Values>()

دالة للحصول على جميع البيانات المتعلقة بأداة بما في ذلك القيم التقنية التي لا يتوقع أن تكون هناك حاجة إليها في معظم الحالات. قد تتغير واجهة برمجة التطبيقات المخصصة للاستخدام الداخلي في الغالب. ضع في اعتبارك استخدام getValues أو getEditorValues بدلا من ذلك.

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

المرتجعات

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

الدالة onChange نفسها مع "الأصل" المقدمة كبارام.

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

المعلمات

origin: string

أصل محتوى الويب (URL) لمدخل التطوير لإرسال التغييرات إلى

instanceId: string

معرف هذا المثيل المحدد من عنصر واجهة المستخدم

values: Values

القيم التي تم تغييرها

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

مفتاح كائن رسالة النشر، يستخدم لطلب وإرسال الأسرار - الرمز ومعرف المستخدم، من بوابة المطورين. يستخدم لمنع التداخل مع تطبيقات أخرى.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

النوع

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

اسم ملف التكوين

APIM_CONFIG_FILE_NAME: "config.msapim.json"

النوع

"config.msapim.json"

APIM_EDITOR_DATA_KEY

مفتاح لتعديل البحث، حيث سيتم تحميل بيانات المحرر.

APIM_EDITOR_DATA_KEY: "editorData"

النوع

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

مفتاح كائن رسالة النشر، يستخدم لنقل التغييرات من المحرر إلى بوابة التطور. يستخدم لمنع التداخل مع تطبيقات أخرى.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

النوع

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

اسم مجلد تخزين الكتلة مع إعدادات الويدجت

BLOB_CONFIGS_FOLDER: "configs"

النوع

"configs"

BLOB_DATA_FOLDER

اسم مجلد تخزين الكتلة مع تنفيذ الويدجت

BLOB_DATA_FOLDER: "data"

النوع

"data"

BLOB_ROOT

جذر مجلد تخزين الكتلة

BLOB_ROOT: "custom-widgets"

النوع

"custom-widgets"

الملاحظات

هل كانت هذه الصفحة مفيدة؟