إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
يشرح هذا البرنامج التعليمي كيفية بدء مخزون واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات لمؤسستك عن طريق تسجيل واجهات برمجة التطبيقات وتعيين بيانات التعريف باستخدام مدخل Microsoft Azure.
لمزيد من المعلومات حول واجهات برمجة التطبيقات وإصدارات واجهة برمجة التطبيقات والتعريفات والكيانات الأخرى التي يمكنك جردها في مركز واجهة برمجة تطبيقات Azure، راجع المفاهيم الأساسية.
في هذا البرنامج التعليمي، ستتعلم كيفية استخدام مدخل Microsoft Azure من أجل:
- تسجيل واحد أو أكثر من واجهات برمجة التطبيقات
- إضافة إصدار API مع تعريف واجهة برمجة التطبيقات
المتطلبات الأساسية
مركز API في اشتراك Azure الخاص بك. لإنشاء واحد، راجع التشغيل السريع: إنشاء مركز واجهة برمجة التطبيقات الخاص بك.
واحد أو أكثر من واجهات برمجة التطبيقات التي تريد تسجيلها في مركز API الخاص بك. فيما يلي مثالان، مع ارتباطات إلى تعريفات OpenAPI الخاصة بهم:
حدد بيانات التعريف المخصصة لواجهات برمجة التطبيقات الخاصة بك من خلال إكمال البرنامج التعليمي السابق، تحديد البيانات الوصفية المخصصة.
تسجيل واجهات برمجة التطبيقات
عند تسجيل (إضافة) واجهة برمجة تطبيقات في مركز واجهة برمجة التطبيقات، يتضمن تسجيل واجهة برمجة التطبيقات ما يلي:
- عنوان (اسم) ونوع ووصف
- معلومات الإصدار
- ارتباطات اختيارية للوثائق وجهات الاتصال
- بيانات التعريف المضمنة والمخصصة التي قمت بتعريفها
بعد تسجيل واجهة برمجة التطبيقات، يمكنك إضافة إصدارات وتعريفات إلى واجهة برمجة التطبيقات.
تسجل الخطوات التالية نموذجين من واجهات برمجة التطبيقات: واجهة برمجة تطبيقات Swagger Petstore وواجهة برمجة تطبيقات المؤتمر (راجع المتطلبات الأساسية). إذا كنت تفضل ذلك، فسجل واجهات برمجة التطبيقات الخاصة بك.
سجل الدخول إلى مدخل Microsoft Azure، ثم انتقل إلى مركز واجهة برمجة التطبيقات.
في قائمة الشريط الجانبي، ضمن مواد العرض، حدد واجهات برمجة التطبيقات>+ تسجيل واجهة برمجة تطبيقات.
في صفحة Register an API ، أضف المعلومات التالية لواجهة برمجة تطبيقات Swagger Petstore. من المفترض أن ترى خط العمل المخصص والبيانات الوصفية العامة التي حددتها في البرنامج التعليمي السابق في أسفل الصفحة.
الإعداد القيمة Description عنوان واجهة برمجة التطبيقات أدخل Swagger Petstore API. الاسم الذي تختاره لواجهة برمجة التطبيقات تعريف بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه. اسم مورد Azure لواجهة برمجة التطبيقات نوع واجهة برمجة التطبيقات حدد REST من القائمة المنسدلة. نوع واجهة برمجة التطبيقات الملخص أدخل ملخصا اختياريا. وصف موجز لواجهة برمجة التطبيقات وصف أدخل وصفا اختياريا. وصف واجهة برمجة التطبيقات الإصدار عنوان الإصدار أدخل عنوان إصدار من اختيارك، مثل v1. الاسم الذي تختاره لإصدار واجهة برمجة التطبيقات تعريف الإصدار بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه. اسم مورد Azure للإصدار دورة حياة الإصدار حدد من القائمة المنسدلة، على سبيل المثال، الاختبار أو الإنتاج. مرحلة دورة حياة إصدار واجهة برمجة التطبيقات وثائق خارجية إضافة ارتباط واحد أو أكثر إلى الوثائق الخارجية اختياريا. اسم ووصف وعنوان URL للوثائق الخاصة بواجهة برمجة التطبيقات الترخيص إضافة معلومات الترخيص اختياريا. الاسم وعنوان URL ومعرف ترخيص واجهة برمجة التطبيقات معلومات جهة الاتصال إضافة معلومات لجهات اتصال واحدة أو أكثر اختياريا. اسم جهة اتصال لواجهة برمجة التطبيقات والبريد الإلكتروني وعنوان URL لها خط العمل إذا أضفت بيانات التعريف هذه في البرنامج التعليمي السابق، فتحقق من القائمة المنسدلة، مثل Marketing. بيانات وصفية مخصصة تحدد وحدة الأعمال التي تمتلك واجهة برمجة التطبيقات مواجهة عامة إذا أضفت بيانات التعريف هذه، فحدد خانة الاختيار. البيانات الوصفية المخصصة التي تحدد ما إذا كانت واجهة برمجة التطبيقات عامة أو داخلية فقط 
حدد إنشاء لتسجيل واجهة برمجة التطبيقات.
كرر الخطوات الثلاث السابقة لتسجيل واجهة برمجة تطبيقات أخرى، مثل واجهة برمجة تطبيقات المؤتمر.
Tip
عند تسجيل واجهة برمجة تطبيقات في مدخل Microsoft Azure، يمكنك تحديد أي من أنواع واجهة برمجة التطبيقات المحددة مسبقا أو إدخال نوع آخر من اختيارك.
تظهر واجهات برمجة التطبيقات على صفحة واجهات برمجة التطبيقات في المدخل. إذا أضفت عددا كبيرا من واجهات برمجة التطبيقات إلى مركز واجهة برمجة التطبيقات، فاستخدم مربع البحث والفلاتر في هذه الصفحة للعثور على واجهات برمجة التطبيقات التي تريدها.
بعد تسجيل واجهة برمجة التطبيقات، يمكنك عرض خصائص واجهة برمجة التطبيقات أو تحريرها. في صفحة واجهات برمجة التطبيقات ، حدد واجهة برمجة التطبيقات لمشاهدة الصفحات لإدارة تسجيل واجهة برمجة التطبيقات.
إضافة إصدار واجهة برمجة التطبيقات
طوال دورة حياتها ، يمكن أن تحتوي واجهة برمجة التطبيقات على إصدارات متعددة. يمكنك إضافة إصدار إلى واجهة برمجة تطبيقات موجودة في مركز واجهة برمجة التطبيقات، بشكل اختياري مع ملف تعريف أو ملفات.
هنا يمكنك إضافة إصدار إلى أحد واجهات برمجة التطبيقات الخاصة بك:
في مدخل Microsoft Azure، انتقل إلى مركز واجهة برمجة التطبيقات الخاص بك.
في قائمة الشريط الجانبي، حدد واجهات برمجة التطبيقات، ثم حدد واجهة برمجة تطبيقات، على سبيل المثال، Swagger Petstore.
في صفحة API، ضمن Details، حدد Versions>+ Add version.
في صفحة إضافة إصدار واجهة برمجة التطبيقات ، أدخل المعلومات التالية أو حددها ضمن تفاصيل الإصدار:
الإعداد القيمة Description عنوان الإصدار أدخل عنوان إصدار من اختيارك، مثل v2. الاسم الذي تختاره لإصدار واجهة برمجة التطبيقات تعريف الإصدار بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه. اسم مورد Azure للإصدار دورة حياة الإصدار قم بإجراء تحديد من القائمة المنسدلة، مثل الإنتاج. مرحلة دورة حياة إصدار واجهة برمجة التطبيقات يدعم Azure API Center التعريفات بتنسيقات مواصفات النص الشائعة، مثل OpenAPI 2 و3 لواجهات برمجة تطبيقات REST. لإضافة تعريف واجهة برمجة التطبيقات، أدخل المعلومات التالية أو حددها ضمن تحديد مواصفات:
الإعداد القيمة Description عنوان التعريف أدخل عنوانا من اختيارك، مثل تعريف v2. الاسم الذي تختاره لتعريف واجهة برمجة التطبيقات تعريف التعريف بعد إدخال العنوان السابق، يقوم Azure API Center بإنشاء هذا المعرف، والذي يمكنك تجاوزه. اسم مورد Azure للتعريف وصف أدخل وصفا اختياريا. وصف تعريف واجهة برمجة التطبيقات تنسيق المواصفات بالنسبة إلى Petstore API، حدد OpenAPI. تنسيق المواصفات لواجهة برمجة التطبيقات إصدار المواصفات أدخل معرف إصدار من اختيارك، مثل 3.0. إصدار المواصفات ملف أو عنوان URL استعرض للوصول إلى ملف تعريف محلي لواجهة برمجة تطبيقات Petstore، أو أدخل عنوان URL. مثال URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yamlملف تعريف واجهة برمجة التطبيقات 
حدد إنشاء.
أثناء إنشاء مخزون واجهة برمجة التطبيقات، استفد من الأدوات التلقائية لتسجيل واجهات برمجة التطبيقات، مثل ملحق Azure API Center ل Visual Studio Code وAzure CLI.
الخطوة التالية
بدأ مخزون واجهة برمجة التطبيقات الخاص بك في التشكل! الآن يمكنك إضافة معلومات حول بيئات API والنشرات.