كتالوج الواجهات
صفحة APIs
| عنصر التحكم | ما يفعله |
|---|---|
| Search by name | يفلتر البطاقات باسم الواجهة |
| Filter by consumption | Both أو Already consumed (واجهات يستدعيها أحد تطبيقاتك أصلًا) أو Not consumed؛ اختر Apply filters أو Reset |
| الوسوم | كل وسم على بطاقة اختصار يبحث عن ذلك الوسم |
| Request access | يفتح Add API to your applications: اختر تطبيقًا أو أكثر من تطبيقاتك، مع تضييق اختياري بحسب الشركة، ثم Save. حيث تشترط المؤسسة اعتمادًا، يبقى الاشتراك معلّقًا حتى يعتمده مسؤول |
| Documentation | يفتح صفحة الواجهة |
يهيّئ المسؤولون الحقول التي تعرضها بطاقة الكتالوج تحت Settings → Catalog. تعرض البطاقة الافتراضية الإصدار والوصف والوسوم وRequests allowed (الحصة) وحد المعدّل وطرق HTTP وجهة الاتصال وآخر تحديث ومخططات الأمان.
عناصر التحكم في صفحة الواجهة
| عنصر التحكم | ما يفعله |
|---|---|
| Version | يبدّل بين إصدارات المواصفة المنشورة. يعرض كل مدخل الإصدار و**(Latest)** للأحدث ووقت نشره |
| المواصفة | توثيق OpenAPI التفاعلي: الخوادم وAuthorize والعمليات مجمّعة بحسب الوسم والمعاملات والاستجابات والمخططات، وTry it out حيث فعّله المسؤول |
| قائمة الصفحة | الزر بجانب عنوان الواجهة. يحوي العناصر أدناه |
| Download spec | ينزّل مواصفة الإصدار المحدد لاستخدامها في أدوات أخرى |
| Compare versions | اختر From version وTo version واقرأ فرقًا منظّمًا لما تغيّر؛ يُبلّغ الإصداران المتطابقان No changes |
عناصر تحكم المنتِج والمسؤول
يرى المنتِجون والمسؤولون إضافةً في قائمة الصفحة:
| عنصر التحكم | ما يفعله |
|---|---|
| Analyze Spec | يفتح Spec Consistency Analysis: درجة اتساق من 100، ولكل مخطط في المواصفة، هل يطابق مدخلًا في Data Dictionary المؤسسة |
| Assign to backend team | يعيّن الفريق المالك لواجهة محمَّلة حديثًا من قائمة فرق الخلفية |
| Reassign to another backend team | ينقل ملكية واجهة معيّنة أصلًا |
| Delete specs | يزيل مواصفات الواجهة من الكتالوج بعد التأكيد |
لم يُطلق بعد
تُشحن صفحة Upload spec (Destination وSpecification وOverlays وReview) وOverride existing version وطبقات الترجمة في إصدار بعد API-dex 3.1.0؛ راجع طبقات اللغة وسجلّ التغييرات. في الإصدار الحالي، تُنشر المواصفات بسطر أوامر API-dex أو يُسقطها حساب CI/CD على صفحة APIs.
الاشتراك
يُشترك بالتطبيق في واجهة من بطاقة الواجهة في الكتالوج بـ Request access، أو من صفحة التطبيق بـ Add/Remove APIs. راجع المرجع: التطبيقات.