Overleaf Import API

اسمح لمواقع أخرى بفتح مقتطفات ومشاريع LaTeX في نشر قائم على Kubernetes.

تعمل Import API (المسار /docs وأزرار “Open in Ayakaleaf”، والوحدة open-in-overleaf) داخل خدمة web في كل pod من Ayakaleaf Pro، وهي مفعّلة افتراضيًا. تُنزَّل الملفات المحدّدة عبر عنوان URL من خلال linked-url-proxy في الـ pod نفسه. أما طريقة استدعائها فموضّحة في Overleaf Import API.

الخدمة	web (الوحدة open-in-overleaf)؛ التنزيل عبر linked-url-proxy
الخارج ← Overleaf	ترسل المتصفحات GET أو POST ${OVERLEAF_SITE_URL}/docs من أي موقع ويب
Pod ← الخارج	تنزيلات snip_uri وzip_uri، مقيّدة كما هو موضّح في عنوان URL الخارجي
الحالة	طلب الزائر غير المسجّل الدخول، يُحفظ في Redis لمدة 10 دقائق إلى أن يسجّل الدخول
المهام الدورية	لا شيء

​

الإعداد

لا يلزم أي شيء لتفعيلها. الإعدادات ذات الصلة في الـ ConfigMap:

الإعداد
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	يمكن للزوار غير المسجّلين الدخول فتح /devs، ويُحفظ الطلب الذي يرسلونه إلى أن يسجّلوا الدخول، راجع الوصول العام.
MAX_UPLOAD_SIZE	أكبر حجم لملف ZIP يمكن أن يحمله الطلب، بالميغابايت (الافتراضي 50). ويجب أن يقبل الـ ingress أو موازن الأحمال لديك أجسام طلبات بهذا الحجم أيضًا.
OVERLEAF_LINKED_URL_*	العناوين التي يمكن أن يشير إليها snip_uri وzip_uri، راجع عنوان URL الخارجي.

​

عدة نسخ متماثلة

لا يلزم أي شيء إضافي. يُحفظ طلب الزائر غير المسجّل الدخول في Redis، لذا يُستأنف على أي نسخة متماثلة يصل إليها الزائر بعد تسجيل الدخول.

​

الاختبار على Kubernetes

على Kubernetes 1.37 مع نسخة متماثلة واحدة، تنجح اختباراتنا الشاملة (end-to-end) لـ Import API (14 حالة): صفحة /devs ومشروعها النموذجي، والمقتطفات، والمستندات الكاملة، والروابط المرمّزة بصيغة URL والملفات من عناوين data URL التي تتحوّل إلى مشاريع، ورفض الطلبات التي لا يمكن أن تصبح مشروعًا، ورفض التنزيلات من العناوين الداخلية، وحفظ الطلبات والروابط المرسلة دون تسجيل الدخول عبر عملية تسجيل الدخول، ومع OVERLEAF_ALLOW_PUBLIC_ACCESS، صفحة /devs للزوار غير المسجّلين الدخول واستئناف مقتطف مُرسَل مرة واحدة بعد تسجيل الدخول؛ وتنجح الحالة الأخيرة أيضًا على ثلاث نسخ متماثلة خلف HAProxy.