مشاركة عبر

استخدام Azure CLI لإدارة مخزون واجهة برمجة التطبيقات

  • مقالة

توضح هذه المقالة كيفية استخدام az apic api الأوامر في Azure CLI لإضافة واجهات برمجة التطبيقات وتكوينها في مخزون مركز API. استخدم الأوامر في Azure CLI لتشغيل عمليات البرنامج النصي لإدارة مخزون واجهة برمجة التطبيقات والجوانب الأخرى لمركز واجهة برمجة التطبيقات.

المتطلبات الأساسية

  • مركز API في اشتراك Azure الخاص بك. إذا لم تكن قد أنشأت واحدا بالفعل، فشاهد التشغيل السريع: إنشاء مركز واجهة برمجة التطبيقات.

  • بالنسبة إلى Azure CLI:

    إشعار

    az apic تتطلب apic-extension الأوامر ملحق Azure CLI. إذا لم تكن قد استخدمت az apic الأوامر، يمكن تثبيت الملحق ديناميكيا عند تشغيل الأمر الأول az apic ، أو يمكنك تثبيت الملحق يدويا. تعرف على المزيد حول ملحقات Azure CLI.

    راجع ملاحظات الإصدار للاطلاع على آخر التغييرات والتحديثات في apic-extension. قد تتطلب بعض الميزات معاينة أو إصدار معين من الملحق.

تسجيل واجهة برمجة التطبيقات وإصدار واجهة برمجة التطبيقات والتعريف

توضح الخطوات التالية كيفية إنشاء واجهة برمجة تطبيقات وربط إصدار API واحد وتعريف واجهة برمجة التطبيقات. للحصول على خلفية حول نموذج البيانات في Azure API Center، راجع المفاهيم الرئيسية.

إنشاء واجهة برمجة تطبيقات

استخدم الأمر az apic api create لإنشاء واجهة برمجة تطبيقات في مركز API الخاص بك.

ينشئ المثال التالي واجهة برمجة تطبيقات تسمى Petstore API في مجموعة موارد myResourceGroup ومركز myAPICenter API. واجهة برمجة التطبيقات هي واجهة برمجة تطبيقات REST.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

إنشاء إصدار واجهة برمجة التطبيقات

استخدم الأمر az apic api version create لإنشاء إصدار لواجهة برمجة التطبيقات الخاصة بك.

ينشئ المثال التالي إصدار API يسمى v1-0-0 لواجهة برمجة تطبيقات petstore-api التي قمت بإنشائها في القسم السابق. يتم تعيين الإصدار إلى مرحلة دورة حياة الاختبار .

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

إنشاء تعريف واجهة برمجة التطبيقات وإضافة ملف المواصفات

استخدم أوامر تعريف واجهة برمجة التطبيقات az apic لإضافة تعريف وملف مواصفات مصاحب لإصدار واجهة برمجة التطبيقات.

إنشاء تعريف

يستخدم المثال التالي الأمر az apic api definition create لإنشاء تعريف يسمى openapi لإصدار petstore-api API الذي قمت بإنشائه في القسم السابق.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

استيراد ملف مواصفات

استيراد ملف مواصفات إلى التعريف باستخدام الأمر az apic api definition import-specification .

يستورد المثال التالي ملف مواصفات OpenAPI من عنوان URL يمكن الوصول إليه بشكل عام إلى تعريف openapi الذي قمت بإنشائه في الخطوة السابقة. name يتم تمرير خصائص و version لمورد المواصفات ك JSON.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

تلميح

يمكنك استيراد ملف المواصفات المضمن عن طريق تعيين المعلمة --format إلى inline وتمرير محتويات الملف باستخدام المعلمة --value .

تصدير ملف مواصفات

لتصدير مواصفات واجهة برمجة التطبيقات من مركز واجهة برمجة التطبيقات إلى ملف محلي، استخدم الأمر az apic api definition export-specification .

يقوم المثال التالي بتصدير ملف المواصفات من تعريف openapi الذي قمت بإنشائه في القسم السابق إلى ملف محلي يسمى specificationFile.json.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

تسجيل واجهة برمجة التطبيقات من ملف مواصفات - خطوة واحدة

يمكنك تسجيل واجهة برمجة تطبيقات من ملف مواصفات محلي في خطوة واحدة باستخدام الأمر az apic api register . باستخدام هذا الخيار، يتم إنشاء إصدار وتعريف افتراضي لواجهة برمجة التطبيقات تلقائيا لواجهة برمجة التطبيقات.

يسجل المثال التالي واجهة برمجة تطبيقات في مركز myAPICenter API من ملف تعريف OpenAPI محلي يسمى specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • يعين الأمر خصائص واجهة برمجة التطبيقات مثل الاسم والنوع من القيم في ملف التعريف.
  • بشكل افتراضي، يعين الأمر مرحلة دورة حياة واجهة برمجة التطبيقات لتصميمها.
  • يقوم بإنشاء إصدار واجهة برمجة التطبيقات المسمى وفقا للخاصية version في تعريف واجهة برمجة التطبيقات (أو 1-0-0 بشكل افتراضي)، وتعريف واجهة برمجة التطبيقات المسمى وفقا لتنسيق المواصفات (على سبيل المثال، openapi).

تحديث خصائص واجهة برمجة التطبيقات

بعد تسجيل واجهة برمجة التطبيقات، يمكنك تحديث خصائص واجهة برمجة التطبيقات باستخدام تحديث az apic api وتحديث إصدار az apic api وaz apic api update أوامر تحديث تعريف api az.

يحدث المثال التالي عنوان واجهة برمجة تطبيقات petstore-api إلى Petstore API v2.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

يعين المثال التالي الخاصية المنطقية المخصصة الداخلية لواجهة برمجة التطبيقات إلى خطأ.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

حذف موارد واجهة برمجة التطبيقات

استخدم الأمر az apic api delete لحذف واجهة برمجة التطبيقات وجميع موارد الإصدار والتعريف الخاصة بها. على سبيل المثال:

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

لحذف إصدارات واجهة برمجة التطبيقات الفردية والتعريفات، استخدم حذف إصدار az apic api وحذف تعريف واجهة برمجة التطبيقات az apic، على التوالي.

المحتوى ذو الصلة