عرض واجهة برمجة التطبيقات الخاصة بك
هذا الدليل مخصص لأدوار الإنتاج — مطوّر في فريق خلفي (backend team)، أو حساب يستخدم دور CI/CD للنشر الآلي. إذا كنت تبحث عن دليل شامل لأول مرة (فريق جديد، بيئة جديدة، أول رفع)، راجع درس نشر واجهة برمجة التطبيقات الخاصة بفريقك بدلًا من ذلك. استخدم هذه الصفحة عندما تكون معتادًا على الخطوات وتحتاج فقط إلى المرجع السريع.
اختر البيئة الصحيحة
افتح عنصر التحكم في البيئة في الشريط العلوي واختر البيئة التي تنتمي إليها واجهة برمجة التطبيقات الخاصة بك. عمليات الرفع وظهورها في الكتالوج مرتبطة بهذه البيئة — راجع البيئات.
افتح واجهات برمجة التطبيقات
اختر واجهات برمجة التطبيقات في الشريط الجانبي الأيسر لفتح الكتالوج للبيئة المحددة.
ارفع المواصفة
استخدم منطقة الرفع / السحب والإفلات لإضافة ملف المواصفة الخاص بك (OpenAPI أو ما شابه). تظهر هذه المنطقة لدور CI/CD وحسابات الإنتاج الأخرى — سواء تم الرفع يدويًا أو من خط أنابيب آلي، فالنتيجة واحدة: منتج جديد ينتظر أن يطالب به فريق خلفي.
إن كانت لديك طبقات لغة، أرفقها في نفس تدفق النشر — انظر الخطوة التالية. تجاوزها إن كنت تنشر المواصفة الأساسية فقط.
أرفق طبقات اللغة (اختياري)
في خطوة الطبقة من معالج الرفع، أرفق أو استبدل ملفًا لكل لغة. أبقِ الملفات الحالية عندما لا تغيّر ترجمة. تمنع البوابة المتابعة إن كان الإصدار الجديد سيُسقط لغة منشورة، أو إن لم يطابق هدف JSONPath أي عقدة في المواصفة. تحتاج ملفات الطبقة إلى info.title مطلوب.
الخلفية: المواصفات المترجمة. التفاصيل: المرجع — طبقات اللغة.
أسندها إلى فريق خلفي
افتح المنتج الذي تم رفعه واستخدم إسناد إلى فريق خلفي (أو إعادة الإسناد إلى فريق آخر إذا كانت مُسندة بالفعل) لاختيار الفريق المالك لها. هذا ما يتيح للمستهلكين معرفة جهة الاتصال للتغييرات أو الحوادث — واجهة برمجة تطبيقات غير مُسندة يصعب على المستهلكين الوثوق بها. راجع إدارة فرقك إذا لم يكن الفريق الخلفي الصحيح موجودًا بعد.
تحقق من ظهورها في الكتالوج
عد إلى واجهات برمجة التطبيقات وتأكد من ظهور المنتج الآن في القائمة لهذه البيئة، مع إمكانية عرض مواصفته.
INFO
بمجرد أن تصبح متاحة، يجدها المستهلكون من واجهات برمجة التطبيقات، يقرؤون المواصفة، ويضيفونها إلى أحد تطبيقاتهم — راجع استهلاك واجهة برمجة تطبيقات لتلك الخطوات.
مواضيع ذات صلة
- نشر واجهة برمجة التطبيقات الخاصة بفريقك — الدرس الكامل الذي يفترض هذا الدليل أنك أكملته مرة واحدة
- إدارة فرقك — الفرق الخلفية، الملكية، والعضوية
- الأدوار وأنواع المستخدمين — أدوار الإنتاج مقابل الاستهلاك، ودور CI/CD
- المرجع — كتالوج واجهات برمجة التطبيقات — كل عنصر تحكم في صفحة المنتج
- المواصفات المترجمة
- المرجع — طبقات اللغة