مدخل واجهة برمجة التطبيقات لخدمة VMware Tanzu

  • مقالة

إشعار

يعد Azure Spring Apps هو الاسم الجديد لخدمة Azure Spring Cloud. رغم أن الخدمة تحمل اسماً جديداً، سترى الاسم القديم في بعض الأماكن لفترة من الوقت بينما نعمل على تحديث الأصول مثل لقطات الشاشة، ومقاطع الفيديو، والرسوم التخطيطية.

تنطبق هذه المقالة على:❌ Basic/Standard ✔️ Enterprise

توضح لك هذه المقالة كيفية استخدام مدخل API ل VMware Tanzu مع خطة Azure Spring Apps Enterprise.

يُعد مدخل واجهة برمجة التطبيقات أحد مكوِّنات VMware Tanzu التجارية. يدعم مدخل API عرض تعريفات واجهة برمجة التطبيقات من Spring Cloud Gateway ل VMware Tanzu واختبار مسارات API محددة من المتصفح. كما يدعم تمكين مصادقة تسجيل الدخول الأحادي (SSO) عبر التكوين.

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

طريقة تكوين تسجيل الدخول الأحادي (SSO)

يدعم مدخل واجهة برمجة التطبيقات المصادقة والترخيص باستخدام تسجيل الدخول الأحادي (SSO) مع موفر هوية OpenID (IdP) الذي يدعم بروتوكول OpenID Connect Discovery.

إشعار

يتم فقط دعم خوادم التخويل التي تدعم بروتوكول OpenID Connect Discovery. تأكد من تكوين خادم التخويل الخارجي للسماح بإعادة التوجيه مرة أخرى إلى مدخل API. ارجع إلى وثائق خادم التخويل الخاصة بك، وأضف https://<api-portal-external-url>/login/oauth2/code/sso إلى قائمة معرفات الموارد المنتظمة لإعادة التوجيه المسموح بها.

الخاصية مطلوب؟ ‏‏الوصف
issuerUri ‏‏نعم‬ معرّف الموارد المنتظم الذي يؤكده التطبيق كمعرّف مصدر الشهادة. على سبيل المثال، إذا كان المصدر-uri المقدم هو "https://example.com"، يتم إجراء طلب تكوين موفر OpenID إلى "https://example.com/.well-known/openid-configuration". ومن المتوقع أن تكون النتيجة استجابة تكوين موفّر OpenID.
clientId ‏‏نعم‬ معرّف العميل OpenID Connect الذي قدمه موفّر الهوية الخاص بك
clientSecret ‏‏نعم‬ بيانات عميل OpenID Connect السرية التي قدمها موفّر الهوية الخاص بك
النطاق ‏‏نعم‬ قائمة النطاقات المُراد إدراجها في رموز هوية JWT المميزة. يتعين أن تستند هذه القائمة إلى النطاقات التي يسمح بها موفّر الهوية

لإعداد تسجيل الدخول الأحادي مع معرف Microsoft Entra، راجع كيفية إعداد تسجيل الدخول الأحادي باستخدام معرف Microsoft Entra ل Spring Cloud Gateway ومدخل API ل Tanzu.

إشعار

إذا كوَّنت خاصية تسجيل دخول أحادي خاطئة، مثل كلمة المرور الخاطئة، يجب عليك إزالة خاصية تسجيل الدخول الأحادي بأكملها وإعادة إضافة التكوين الصحيح.

تكوين حساب المثيل

استخدم الخطوات التالية لتكوين عدد المثيلات باستخدام مدخل API:

  1. انتقل إلى مثيل الخدمة وحدد مدخل API.
  2. حدد Scale out.
  3. قم بتكوين عدد المثيلات ثم حدد حفظ.

تعيين نقطة النهاية العامة لمدخل واجهة برمجة التطبيقات

استخدم الخطوات التالية لتعيين نقطة نهاية عامة إلى مدخل واجهة برمجة التطبيقات:

  1. حدد مدخل واجهة برمجة التطبيقات.
  2. حدد نظرة عامة لعرض حالة التشغيل والموارد المخصصة لمدخل واجهة برمجة التطبيقات.
  3. حدد نعم بجانب تعيين نقطة النهاية لتعيين نقطة النهاية العامة. يتم إنشاء عنوان URL في غضون بضع دقائق.
  4. احفظ عنوان موقع الويب لاستخدامه لاحقًا.

تكوين ميزة تجربة واجهة برمجة التطبيقات

يمكنك مدخل واجهة برمجة التطبيقات من عرض واجهات برمجة التطبيقات مركزيا وتجربتها باستخدام ميزة تجربة واجهة برمجة التطبيقات. يتم تمكين تجربة واجهة برمجة التطبيقات بشكل افتراضي ويساعدك هذا التكوين على إيقاف تشغيلها عبر مثيل مدخل API بأكمله. لمزيد من المعلومات، راجع قسم تجربة واجهات برمجة التطبيقات في مدخل واجهة برمجة التطبيقات.

استخدم الخطوات التالية لتمكين تجربة واجهة برمجة التطبيقات أو تعطيلها:

  1. انتقل إلى مثيل الخدمة وحدد مدخل API.
  2. حدد تكوين.
  3. حدد تمكين تجربة واجهة برمجة التطبيقات أو قم بإلغاء تحديدها ثم حدد حفظ.

تكوين توجيه واجهة برمجة التطبيقات باستخدام OpenAPI Spec على Spring Cloud Gateway ل Tanzu

يصف هذا القسم كيفية عرض واجهات برمجة التطبيقات وتجربتها باستخدام تعريفات المخطط في مدخل واجهة برمجة التطبيقات. استخدم الخطوات التالية لتكوين توجيه واجهة برمجة التطبيقات باستخدام عنوان URL لمواصفات OpenAPI على Spring Cloud Gateway for Tanzu.

  1. أنشئ تطبيقا في Azure Spring Apps توجه البوابة نسبة استخدام الشبكة إليه.

  2. إنشاء تعريف OpenAPI والحصول على URI للوصول إليه. يتم قبول خياري URI التاليين:

    • الخيار الأول هو استخدام نقطة نهاية يمكن الوصول إليها بشكل عام مثل URI https://petstore3.swagger.io/api/v3/openapi.json، والتي تتضمن مواصفات OpenAPI.
    • الخيار الثاني هو وضع تعريف OpenAPI في المسار النسبي للتطبيق في Azure Spring Apps، وإنشاء URI بالتنسيق http://<app-name>/<relative-path-to-OpenAPI-spec>. يمكنك اختيار أدوات مثل SpringDocs إنشاء مواصفات OpenAPI تلقائيا، بحيث يمكن أن يكون URI مثل http://<app-name>/v3/api-docs.

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

    az spring gateway update --assign-endpoint

  4. استخدم الأمر التالي لتكوين خصائص configure Spring Cloud Gateway for Tanzu:

    az spring gateway update \
    --api-description "<api-description>" \
    --api-title "<api-title>" \
    --api-version "v0.1" \
    --server-url "<endpoint-in-the-previous-step>" \
    --allowed-origins "*"

  5. تكوين قواعد التحويل إلى التطبيقات.

    لإنشاء قواعد للوصول إلى التطبيق في تكوين مسار Spring Cloud Gateway for Tanzu، احفظ المحتويات التالية في ملف sample.json .

    {
   "open_api": {
      "uri": "https://petstore3.swagger.io/api/v3/openapi.json"
   },
   "routes": [
      {
         "title": "Petstore",
         "description": "Route to application",
         "predicates": [
            "Path=/pet",
            "Method=PUT"
         ],
         "filters": [
            "StripPrefix=0"
         ]
      }
   ]
}

    open_api.uri القيمة هي نقطة النهاية العامة أو URI التي تم إنشاؤها في الخطوة الثانية أعلاه. يمكنك إضافة دالات تقييم وعوامل تصفية للمسارات المحددة في مواصفات OpenAPI.

    استخدم الأمر التالي لتطبيق القاعدة على التطبيق الذي تم إنشاؤه في الخطوة الأولى:

    az spring gateway route-config create \
    --name sample \
    --app-name <app-name> \
    --routes-file sample.json

  6. تحقق من استجابة المسارات التي تم إنشاؤها. يمكنك أيضًا عرض المسارات في المدخل.

عرض واجهات برمجة التطبيقات المكشوفة في مدخل واجهة برمجة التطبيقات

إشعار

تستغرق المزامنة بين Spring Cloud Gateway لبوابة Tanzu وواجهة برمجة التطبيقات عدة دقائق.

حدد endpoint URL للذهاب إلى مدخل واجهة برمجة التطبيقات. ترى جميع المسارات التي تم تكوينها في Spring Cloud Gateway ل Tanzu.

لقطة شاشة لمدخل API تعرض المسارات المكونة.

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

استخدم الخطوات التالية لتجربة واجهات برمجة التطبيقات:

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

  2. حدد EXECUTE، وتظهر الاستجابة.

    لقطة شاشة لمدخل API تعرض خيار Execute المحدد.

تمكين/تعطيل مدخل واجهة برمجة التطبيقات بعد إنشاء الخدمة

يمكنك تمكين وتعطيل مدخل API بعد إنشاء الخدمة باستخدام مدخل Azure أو Azure CLI. قبل تعطيل مدخل API، يطلب منك إلغاء تعيين نقطة النهاية الخاصة به.

استخدم الخطوات التالية لتمكين مدخل واجهة برمجة التطبيقات أو تعطيله باستخدام مدخل Microsoft Azure:

  1. انتقل إلى مورد الخدمة، ثم حدد مدخل API.
  2. حدد إدارة.
  3. حدد أو قم بإلغاء تحديد مدخل Enable API، ثم حدد Save.
  4. يمكنك الآن عرض حالة مدخل واجهة برمجة التطبيقات على صفحة مدخل واجهة برمجة التطبيقات.

الخطوات التالية