Skip to main content
تعيد بشكل مُرقّم وثائق المطور المرئية للموقع الحالي، ويمكن استخدامها للبحث أو الفهرسة أو بناء التنقل في العميل بشكل مستقل. تحتوي القائمة حاليًا على content ومعلومات الأصل المتداخلة لكل وثيقة، وقد تكون الاستجابة كبيرة.

نظرة عامة على الواجهة

معاملات الاستعلام

لا تدعم واجهة القائمة الحالية التصفية بواسطة alias أو parent_id. عند معرفة alias، استدعِ تفاصيل الوثيقة مباشرةً؛ وعند إنشاء تنقل شجري، اسحب الصفحات دفعةً واحدة ثم جمّعها في العميل باستخدام parent.id لكل عنصر.

أمثلة الطلبات

بنية الاستجابة

تستخدم القائمة DocumentIndexSerializer، وتُرجع حاليًا حقول النموذج والعلاقات المتداخلة؛ وقد تحتوي وثائق API المرتبطة أيضًا على api_method. قد تُضاف الحقول بتوافق رجعي، وينبغي للعميل قراءتها حسب الحاجة. عند الحاجة إلى children، ولغة المحتوى المحللة، وتجزئة المحتوى، استخدم واجهة التفاصيل. بالنسبة للسجلات العامة المرتبطة بوثائق المصدر، يوفر content_source معرّف وثيقة المصدر، وتجزئة محتوى المصدر، واللغة المطلوبة، ووقت تحديث الترجمة، وحالة ready أو stale أو missing أو missing_source أو ambiguous؛ ويكون هذا الحقل null للسجلات الأخرى. تتوافق content_hash عند ready مع ترجمة تلك اللغة. لا يزال النص يُعرض وفق القواعد الأصلية، بما في ذلك الرجوع إلى لغة بديلة عند فقدان الترجمة؛ ويجب على العملاء الذين يحتاجون إلى مزامنة الوثائق التحقق من الحالة والتجزئة معًا، ولا يمكنهم الحكم على اكتمال التحديث اعتمادًا على أن النص غير فارغ فقط.

توصيات الاستخدام

  • تحتوي الاستجابة على النص، لذا استخدم الترقيم واضبط مهلة معقولة عند المزامنة المجمعة، ولا تجلب الصفحة نفسها بالتوازي.
  • alias هو المعرّف المستقر لعنوان URL للصفحة العامة؛ عند معرفة alias، اطلب /api/v1/documents/{alias} مباشرةً.
  • لا يمكن للواجهة الحالية إجراء التصفية حسب الأصل على جانب الخادم؛ وعند إنشاء التنقل، جمّع حسب parent.id في العميل.

الواجهات ذات الصلة