بداية بوابة APICenter

استضافة ذاتية لبوابة Azure API Center الخاصة بك

ملخص

• ما هو مركز Azure API؟
• ما هي بوابة مركز Azure API؟
• المتطلبات الأساسية
• بداية سريعة
  • النشر الآلي باستخدام azd
  • تشغيل البوابة محليا
  • النشر اليدوي لتطبيقات الويب Azure الثابتة
• المساهمة
• الأخطاء والقضايا والتعليقات
• مدونة لقواعد السلوك
• إشعار العلامة التجارية
• القياس عن بعد
• رخصة

ما هي بوابة Azure API Center؟

يعد Azure API Center خدمة تساعدك على تطوير مخزون منظم لواجهات برمجة التطبيقات الخاصة بمؤسستك والحفاظ عليه. باستخدام مركز واجهة برمجة التطبيقات (API Center)، يمكنك تتبع جميع واجهات برمجة التطبيقات (APIs) الخاصة بك في موقع مركزي، بغض النظر عن نوعها أو مرحلة دورة حياتها أو موقع نشرها. يتيح مركز واجهة برمجة التطبيقات (API Center) إمكانية اكتشاف واجهة برمجة التطبيقات (API) وإعادة استخدامها وإدارتها لتمكين فرق منصة واجهة برمجة التطبيقات (API Platform Teams).

بوابة مركز Azure API

بوابة API Center هي موقع ويب يمكّن المطورين وأصحاب المصلحة من اكتشاف واجهات برمجة التطبيقات والتفاعل معها بسلاسة. يمكّن تطبيقنا المرجعي لبوابة API Center فرق منصة API من توفير تجربة اكتشاف واستهلاك واجهة برمجة التطبيقات على الويب لمستهلكي واجهة برمجة التطبيقات.

يوفر التنفيذ المرجعي لبوابة مركز API ما يلي:

• إطار عمل لنشر وصيانة بوابة API التي يديرها العميل.
• منصة بوابة يمكن للعملاء تعديلها أو توسيعها لتلبية احتياجاتهم.
• مرونة الاستضافة على بنيات أساسية مختلفة، بما في ذلك النشر إلى Azure Static Web Apps أو Azure App Service.

القيود

بالنسبة لمثيلات SKU API Center المجانية، سيتم عرض 5 واجهات برمجة تطبيقات كحد أقصى في بوابة مركز API بغض النظر عن عدد واجهات برمجة التطبيقات الموجودة في مركز API.

بالنسبة إلى SKU القياسي، لا يوجد حد وسيتم عرض جميع واجهات برمجة التطبيقات.

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

قبل البدء، تأكد من استيفاء المتطلبات التالية:

1. ✅ لقد قمت بتثبيت أحدث إصدار من Node.js وnpm.
2. ✅ باقة فايت .

بداية سريعة

لديك خياران لنشر بوابة مركز API المستضافة ذاتيًا:

• النشر التلقائي – استخدم واجهة سطر الأوامر لمطور Azure ( azd ) للنشر بخطوة واحدة لتطبيق البوابة الإلكترونية. يوصى بهذا الخيار لعملية نشر مبسطة.
• النشر اليدوي – اتبع الإرشادات خطوة بخطوة لنشر تطبيق Azure Functions وتكوين اشتراك الحدث. يوصى بهذا الخيار إذا كنت تفضل نشر الموارد وإدارتها يدويًا.

النشر الآلي باستخدام azd

ملاحظة : سوف تحتاج إلى المتطلبات الإضافية لهذا الخيار

• ✅ Azure Developer CLI ( azd )
• ✅ أزور CLI
• ✅ جيثب CLI

1. قم بتقسيم هذا المستودع إلى حساب GitHub الخاص بك وقم باستنساخه.

   git clone https://github.com/ < YOUR_GITHUB_ALIAS > /APICenter-Portal-Starter.git

2. قم بتسجيل الدخول باستخدام الأمر التالي. بعد ذلك، ستتمكن من استخدام azd cli لتوفير التطبيق ونشره بسرعة.

    # Authenticate with Azure Developer CLI
   azd auth login
   
   # Authenticate with Azure CLI
   az login

3. قم بتشغيل azd up لتوفير كافة الموارد لـ Azure ونشر التعليمات البرمجية على تلك الموارد.

   azd up

   أدخل اسم البيئة وحدد subscription location المطلوبين. بعد ذلك، سيُطلب منك إدخال بعض القيم الإضافية:

   1. اختر ما إذا كنت تريد استخدام مثيل موجود لمركز API أم لا ( apiCenterExisted ).
   2. قم بتمرير قيم apiCenterName و apiCenterRegion و apiCenterResourceGroupName ، إذا اخترت استخدام مورد مركز API الحالي (قيمة apiCenterExisted إلى true ).
   3. اتركها فارغة، إذا اخترت إنشاء مورد مركز API جديد (قيمة apiCenterExisted إلى false ).
   4. قم بتمرير قيمة staticAppLocation لمثيل Azure Static Web Apps. انتظر لحظة حتى يكتمل نشر الموارد.

   هناك سيناريوهان:

   1. بوابة مع مركز واجهة برمجة التطبيقات الجديد - تحتاج إلى إعطاء False لـ apiCenterExisted وترك apiCenterName و apiCenterRegion و apiCenterResourceGroupName فارغًا.
   2. بوابة مع مركز API الموجود - تحتاج إلى إعطاء True لـ apiCenterExisted وتمرير القيم إلى apiCenterName و apiCenterRegion و apiCenterResourceGroupName .

4. إذا كنت تريد دمج خط أنابيب CI/CD مع GitHub Actions، فيمكنك استخدام الأمر التالي لإنشاء مستودع GitHub ودفع الكود إلى المستودع. أولا قم بتسجيل الدخول إلى موقع GitHub.

    # Authenticate with GitHub CLI
   gh auth login

5. قم بتشغيل الأوامر التالية لتحديث متغيرات مستودع GitHub.

   ملاحظة : تأكد من قيامك بتقسيم هذا المستودع إلى حساب GitHub الخاص بك قبل تشغيل الأوامر التالية.

    # Bash
   AZURE_CLIENT_ID= $( ./infra/scripts/get-azdvariable.sh --key AZURE_CLIENT_ID )
   azd pipeline config --principal-id $AZURE_CLIENT_ID
   
   # PowerShell
   $AZURE_CLIENT_ID = $( ./infra/scripts/Get-AzdVariable.ps1 -Key AZURE_CLIENT_ID )
   azd pipeline config --principal-id $AZURE_CLIENT_ID

6. الآن، أنت جاهز للذهاب! ادفع الكود إلى مستودع GitHub أو قم بتشغيل سير عمل GitHub Actions يدويًا لنشر بوابتك الإلكترونية.

تكوين عوامل تصفية النطاق

افتراضيًا، تعرض البوابة جميع واجهات برمجة التطبيقات من مثيل مركز واجهة برمجة التطبيقات الخاص بك. يمكنك تكوين مثيل البوابة الإلكترونية لتصفية واجهات برمجة تطبيقات معينة عن طريق تعيين خاصية scopingFilter في الملف public/config.example باستخدام بناء جملة استعلام OData. على سبيل المثال:

.data..azure-apicenter.ms/workspaces/default", "title": "API portal", "authentication": { "clientId": "", "tenantId": "", "scopes": ["https://azure-apicenter.net/user_impersonation"], "authority": "https://login.microsoftonline.com/" }, "scopingFilter": "customProperties/compliant eq true" }" style=";text-align:right;direction:rtl">

 {
  "dataApiHostName": ".data..azure-apicenter.ms/workspaces/default",
  "title": "API portal",
  "authentication": {
      "clientId": "",
      "tenantId": "",
      "scopes": ["https://azure-apicenter.net/user_impersonation"],
      "authority": "https://login.microsoftonline.com/"
  },
  "scopingFilter": "customProperties/compliant eq true"
}

للحصول على قائمة كاملة بالخصائص القابلة للتصفية، راجع نموذج موارد واجهة برمجة تطبيقات dataplane.

تشغيل البوابة محليا

ملاحظة : ستحتاج إلى المتطلبات الأساسية الإضافية لهذا الخيار

• ✅ تسجيل التطبيق الذي تم تكوينه في مستأجر Microsoft Entra ID الخاص بك باستخدام نطاق إذن API الصحيح وإعادة توجيه URI.
• ✅ تم تمكين تسجيل الدخول إلى البوابة مع تعيين الدور الصحيح

اتبع هذه الخطوات لإعداد بيئة التطوير الخاصة بك:

1. استنساخ المستودع

   git clone https://github.com/Azure/APICenter-Portal-Starter.git

2. التحول إلى الفرع الرئيسي:

   git checkout main

3. انسخ أو أعد تسمية الملف public/config.example إلى public/config.json .

4. قم بتكوين الملف public/config.json للإشارة إلى خدمة Azure API Center الخاصة بك. فيما يلي مثال للتكوين:

   .data..azure-apicenter.ms/workspaces/default", "title": "API portal", "authentication": { "clientId": "", "tenantId": "", "scopes": ["https://azure-apicenter.net/user_impersonation"], "authority": "https://login.microsoftonline.com/" } }" style=";text-align:right;direction:rtl">

   {
     "dataApiHostName" : " .data..azure-apicenter.ms/workspaces/default " ,
     "title" : " API portal " ,
     "authentication" : {
         "clientId" : "  " ,
         "tenantId" : "  " ,
         "scopes" : [ " https://azure-apicenter.net/user_impersonation " ],
         "authority" : " https://login.microsoftonline.com/ "
     }
   }

5. تثبيت الحزم المطلوبة.

   npm install

6. بدء تشغيل خادم التطوير - سيبدأ هذا الأمر تشغيل البوابة الإلكترونية في وضع التطوير محليًا:

   npm start

النشر اليدوي لتطبيقات الويب Azure الثابتة

Azure Static Web Apps هي خدمة تقوم تلقائيًا بإنشاء تطبيقات ويب مكدسة كاملة ونشرها إلى Azure من مستودع التعليمات البرمجية. يستخدم هذا البرنامج التعليمي إجراءات GitHub للنشر في Azure Static Web Apps.

1. إنشاء تطبيق ويب ثابت جديد.
2. حدد جيثب كمصدر .
3. حدد مؤسسة GitHub والمستودع والفرع الذي يحتوي على بوابة مركز API. ملاحظة: يجب عليك تقسيم مستودع بوابة API Center إلى حسابك الشخصي أو مؤسستك وتحديد هذا المستودع.
4. حدد رد الفعل كإعدادات البناء المسبقة .
5. أدخل / كموقع التطبيق .
6. أدخل dist كموقع الإخراج .
7. انقر فوق إنشاء . سيتم الالتزام بملف سير عمل GitHub في المستودع المحدد في الخطوة رقم 3، وسيبدأ النشر إلى تطبيق الويب الثابت الخاص بك باستخدام إجراءات GitHub. قد يستغرق الأمر ما يصل إلى خمس دقائق حتى يتم نشر التغييرات.

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

المساهمة

راجع إرشادات المساهمة للحصول على أفكار وإرشادات حول كيفية تحسين القالب. شكرًا لك!

الأخطاء والقضايا والتعليقات

☀️ نحن نحب أن نسمع منك! ☀️

تعليقاتك لا تقدر بثمن بالنسبة لنا، ونحن نشجعك على مشاركة أفكارك واقتراحاتك في قسم المشكلات في المستودع. يمكنك أيضًا الإبلاغ عن الأخطاء أو إرسال طلبات الميزات هناك. كن مطمئنًا، سنراقب مدخلاتك عن كثب من أجل التحسين المستمر. على الرغم من أننا ملتزمون بمراقبة هذه المشكلات، يرجى ملاحظة أن هذه القناة ليست جزءًا من دعم خدمة Microsoft Azure.

تقتصر مساعدة دعم Microsoft Azure على الإعداد الأولي لتطبيق Azure Function الذي يقوم بتشغيل محرك الفحص. يتم تقديم أفضل دعم للمشاكل التي تنتج عن العوامل البيئية، مثل (على سبيل المثال لا الحصر): النظام الأساسي للاستضافة، وبيئة التطوير، وتكوين الشبكة.

إذا كنت بحاجة إلى مساعدة فنية فيما يتعلق بتوسيع محرك الفحص أو تحسين القواعد الحالية، فيرجى الاستفادة من المجتمعات التقنية الحالية مثل Stack Overflow. نحن لا نقدم الدعم من خلال مشكلات GitHub.

نحن نرحب ونقدر مساهمات المجتمع.

مدونة لقواعد السلوك

اعتمد هذا المشروع قواعد السلوك الخاصة بشركة Microsoft مفتوحة المصدر. لمزيد من المعلومات، راجع الأسئلة الشائعة حول قواعد السلوك أو اتصل بـ [email protected] لطرح أي أسئلة أو تعليقات إضافية.

إشعار العلامة التجارية

العلامات التجارية قد يحتوي هذا المشروع على علامات تجارية أو شعارات للمشاريع أو المنتجات أو الخدمات. يخضع الاستخدام المصرح به للعلامات التجارية أو الشعارات الخاصة بشركة Microsoft ويجب أن يتبع إرشادات العلامة التجارية والعلامات التجارية الخاصة بشركة Microsoft. يجب ألا يتسبب استخدام العلامات التجارية أو الشعارات الخاصة بشركة Microsoft في الإصدارات المعدلة من هذا المشروع في حدوث ارتباك أو الإشارة ضمنًا إلى رعاية Microsoft. ويخضع أي استخدام لعلامات تجارية أو شعارات تابعة لجهات خارجية لسياسات تلك الجهات الخارجية.

القياس عن بعد

جمع البيانات. قد يقوم البرنامج بجمع معلومات عنك وعن استخدامك للبرنامج وإرسالها إلى Microsoft. يجوز لشركة Microsoft استخدام هذه المعلومات لتوفير الخدمات وتحسين منتجاتنا وخدماتنا. يمكنك إيقاف تشغيل القياس عن بعد كما هو موضح في المستودع. توجد أيضًا بعض الميزات في البرنامج التي قد تمكنك أنت وMicrosoft من جمع البيانات من مستخدمي تطبيقاتك. إذا كنت تستخدم هذه الميزات، فيجب عليك الالتزام بالقانون المعمول به، بما في ذلك تقديم الإشعارات المناسبة لمستخدمي تطبيقاتك بالإضافة إلى نسخة من بيان خصوصية Microsoft. يوجد بيان الخصوصية الخاص بنا على https://go.microsoft.com/fwlink/?LinkID=824704. يمكنك معرفة المزيد حول جمع البيانات واستخدامها في وثائق المساعدة وبيان الخصوصية الخاص بنا. يعتبر استخدامك للبرنامج بمثابة موافقتك على هذه الممارسات.

رخصة

معهد ماساتشوستس للتكنولوجيا