نظرة عامة

يعمل Overleaf كعدة خدمات يستدعي بعضها بعضًا عبر HTTP داخل شبكة Docker. تصف الصفحات في هذا القسم واجهات البرمجة الداخلية هذه. وهي مأخوذة من ملفات OpenAPI في develop/hoppscotch/openapi/، المكتوبة استنادًا إلى شيفرة كل خدمة.

لا توجد واجهة عامة بين هذه الواجهات: لا يمكن الوصول إليها إلا من داخل شبكة Docker، ومعظمها بلا مصادقة.

​

الخدمات

الخدمة	العنوان	ما تفعله
web	http://web:3000	التطبيق الرئيسي. تستدعي واجهته الخاصة الخدماتُ الأخرى وبرامج cron في الصورة
document-updater	http://document-updater:3003	تحتفظ بالمستندات المفتوحة في المحرر داخل Redis، وتطبّق التعديلات وتعيد كتابتها إلى Mongo
docstore	http://docstore:3016	تخزّن كل مستند لكل مشروع في مجموعة Mongo ‏docs
real-time	http://real-time:3026	تحتفظ باتصالات socket.io للمحرر وتنقل التعديلات بين المتصفحات والخدمات
chat	http://chat:3010	تخزّن محادثة المشروع وسلاسل التعليقات
project-history	http://project-history:3054	تحوّل التعديلات المنتظرة إلى تغييرات في السجل وترسلها إلى history-v1؛ وتحتفظ بالتسميات
history-v1	http://history-v1:3100	تخزّن السجل الكامل لكل مشروع ومحتوى الملفات ككائنات blob
filestore	http://filestore:3009	تقدّم ملفات القوالب، وللقراءة فقط، كائنات blob التي يكتبها history-v1
clsi	http://clsi:3013	تترجم المشاريع، وتشغّل SyncTeX وعدّ الكلمات، وتحوّل المستندات
notifications	http://notifications:3042	تخزّن الإشعارات المعروضة في قائمة المشاريع
linked-url-proxy	http://linked-url-proxy:3066	تجلب عناوين URL خارجية لصالح web وترفض العناوين الداخلية
third-party-datastore	http://third-party-datastore:3002	تزامن المشاريع مع Dropbox عبر طابور مهام واحد لكل مستخدم

​

المصادقة

• web: مصادقة HTTP الأساسية باستخدام WEB_API_USER وWEB_API_PASSWORD. تستخدم مسارات git-bridge رمز وصول شخصيًا بدلًا من ذلك.
• history-v1: مصادقة HTTP الأساسية باسم staging مع STAGING_PASSWORD، أو JWT.
• جميع الخدمات الأخرى: لا شيء.

​

جرّبها

تشغّل بيئة التطوير Hoppscotch على http://localhost:9170، مع وكيل يصل إلى الخدمات عبر عناوينها في Docker. يوضّح ملف README الخاص بها كيفية ضبط الوكيل واستيراد ملفات OpenAPI.