البرنامج التعليمي: تسجيل واجهات برمجة التطبيقات في مخزون واجهة برمجة التطبيقات

في هذا البرنامج التعليمي، ابدأ مخزون واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات لمؤسستك عن طريق تسجيل واجهات برمجة التطبيقات وتعيين بيانات التعريف باستخدام مدخل Microsoft Azure.

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

في هذا البرنامج التعليمي، ستتعلم كيفية استخدام المدخل من أجل:

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

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

• واحد أو أكثر من واجهات برمجة التطبيقات التي تريد تسجيلها في مركز API الخاص بك. فيما يلي مثالان، مع ارتباطات إلى تعريفات OpenAPI الخاصة بهم:

  • واجهة برمجة تطبيقات Swagger Petstore
  • واجهة برمجة تطبيقات المؤتمر

• أكمل البرنامج التعليمي السابق، تعريف بيانات التعريف المخصصة، لتعريف بيانات التعريف المخصصة لواجهات برمجة التطبيقات الخاصة بك.

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

عند تسجيل (إضافة) واجهة برمجة تطبيقات في مركز واجهة برمجة التطبيقات، يتضمن تسجيل واجهة برمجة التطبيقات ما يلي:

• عنوان (اسم) ونوع ووصف
• معلومات الإصدار
• ارتباطات اختيارية للوثائق وجهات الاتصال
• بيانات التعريف المضمنة والمخصصة التي قمت بتعريفها

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

تسجل الخطوات التالية نموذجين من واجهات برمجة التطبيقات: واجهة برمجة تطبيقات Swagger Petstore وواجهة برمجة تطبيقات المؤتمر (راجع المتطلبات الأساسية). إذا كنت تفضل ذلك، فسجل واجهات برمجة التطبيقات الخاصة بك.

1. في المدخل، انتقل إلى مركز API الخاص بك.

2. في القائمة اليسرى، ضمن Assets، حدد APIs>+ Register an API.

3. في صفحة Register an API ، أضف المعلومات التالية لواجهة برمجة تطبيقات Swagger Petstore. سترى خط العمل المخصص وبيانات التعريف العامة التي حددتها في البرنامج التعليمي السابق في أسفل الصفحة.

   الإعداد	قيمة	‏‏الوصف
   عنوان واجهة برمجة التطبيقات	أدخل Swagger Petstore API.	الاسم الذي تختاره لواجهة برمجة التطبيقات.
   تعريف	بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه.	اسم مورد Azure لواجهة برمجة التطبيقات.
   نوع واجهة برمجة التطبيقات	حدد REST من القائمة المنسدلة.	نوع واجهة برمجة التطبيقات.
   الملخص	أدخل ملخصا اختياريا.	وصف ملخص لواجهة برمجة التطبيقات.
   الوصف	أدخل وصفا اختياريا.	وصف واجهة برمجة التطبيقات.
   ‏‏الإصدار
   عنوان الإصدار	أدخل عنوان إصدار من اختيارك، مثل v1.	الاسم الذي تختاره لإصدار واجهة برمجة التطبيقات.
   تعريف الإصدار	بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه.	اسم مورد Azure للإصدار.
   دورة حياة الإصدار	حدد من القائمة المنسدلة، على سبيل المثال، الاختبار أو الإنتاج.	مرحلة دورة حياة إصدار واجهة برمجة التطبيقات.
   وثائق خارجية	إضافة ارتباط واحد أو أكثر إلى الوثائق الخارجية اختياريا.	اسم الوثائق ووصفها وعنوان URL الخاص بها لواجهة برمجة التطبيقات.
   الترخيص	إضافة معلومات الترخيص اختياريا.	اسم ترخيص واجهة برمجة التطبيقات وعنوان URL ومعرفه.
   معلومات جهة الاتصال	إضافة معلومات لجهات اتصال واحدة أو أكثر اختياريا.	الاسم والبريد الإلكتروني وعنوان URL لجهة اتصال لواجهة برمجة التطبيقات.
   خط العمل	إذا أضفت بيانات التعريف هذه في البرنامج التعليمي السابق، فتحقق من القائمة المنسدلة، مثل Marketing.	بيانات التعريف المخصصة التي تحدد وحدة الأعمال التي تمتلك واجهة برمجة التطبيقات.
   مواجهة عامة	إذا أضفت بيانات التعريف هذه، فحدد خانة الاختيار.	بيانات التعريف المخصصة التي تحدد ما إذا كانت واجهة برمجة التطبيقات عامة أو داخلية فقط.

   

4. حدد إنشاء. تم تسجيل واجهة برمجة التطبيقات.

5. كرر الخطوات الثلاث السابقة لتسجيل واجهة برمجة تطبيقات أخرى، مثل واجهة برمجة تطبيقات المؤتمر.

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

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

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

طوال دورة حياتها، يمكن أن يكون لواجهة برمجة التطبيقات إصدارات متعددة. يمكنك إضافة إصدار إلى واجهة برمجة تطبيقات موجودة في مركز واجهة برمجة التطبيقات، بشكل اختياري مع ملف تعريف أو ملفات.

هنا يمكنك إضافة إصدار إلى أحد واجهات برمجة التطبيقات الخاصة بك:

1. في المدخل، انتقل إلى مركز API الخاص بك.

2. في القائمة اليسرى، حدد واجهات برمجة التطبيقات، ثم حدد واجهة برمجة تطبيقات، على سبيل المثال، Swagger Petstore.

3. في صفحة API، ضمن Details، حدد Versions>+ Add version.

   

4. في صفحة Add API version :

   1. أدخل المعلومات التالية أو حددها:

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

   2. حدد إنشاء. تتم إضافة الإصدار.

إضافة تعريف إلى الإصدار الخاص بك

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

لإضافة تعريف API إلى الإصدار الخاص بك:

1. في صفحة الإصدارات من واجهة برمجة التطبيقات الخاصة بك، حدد إصدار واجهة برمجة التطبيقات.

2. في القائمة اليسرى من إصدار واجهة برمجة التطبيقات، ضمن تفاصيل، حدد تعريفات> + إضافة تعريف.

3. في صفحة إضافة تعريف :

   1. أدخل المعلومات التالية أو حددها:

      الإعداد	قيمة	‏‏الوصف
      العنوان	أدخل عنوانا من اختيارك، مثل تعريف v2.	الاسم الذي تختاره لتعريف واجهة برمجة التطبيقات.
      تعريف	بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه.	اسم مورد Azure للتعريف.
      الوصف	أدخل وصفا اختياريا.	وصف تعريف واجهة برمجة التطبيقات.
      اسم المواصفة	بالنسبة إلى Petstore API، حدد OpenAPI.	تنسيق المواصفات لواجهة برمجة التطبيقات.
      إصدار المواصفات	أدخل معرف إصدار من اختيارك، مثل 3.0.	إصدار المواصفات.
      مستند	استعرض للوصول إلى ملف تعريف محلي لواجهة برمجة تطبيقات Petstore، أو أدخل عنوان URL. مثال URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	ملف تعريف واجهة برمجة التطبيقات.

      

   2. حدد إنشاء. تتم إضافة التعريف.

في هذا البرنامج التعليمي، تعلمت كيفية استخدام المدخل من أجل:

أثناء إنشاء مخزون واجهة برمجة التطبيقات، استفد من الأدوات التلقائية لتسجيل واجهات برمجة التطبيقات، مثل ملحق Azure API Center ل Visual Studio Code وAzure CLI.

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

بدأ مخزون واجهة برمجة التطبيقات الخاص بك في التشكل! الآن يمكنك إضافة معلومات حول بيئات API والنشرات.