واجهة API التجريبية المدمجة

ما هو

تحمل لوحة التحكم خادمًا صغيرًا خاصًا بها يعمل في المتصفح. يجيب كل طلب تقدّمه لوحة التحكم، بالإجابات ورموز الحالة وفحوص الصلاحيات نفسها التي في واجهة NestJS API، فتعمل كل شاشة من دون أي back-end. وهو ما تعمل عليه حزمة لوحة الإدارة مباشرة، وما ترجع إليه لوحة تحكم الحزمة الكاملة عندما لا يُضبط عنوان لواجهة API.

يظهر إشعار «بيانات تجريبية» أسفل كل صفحة ما دام يجيب، حتى لا يظنه أحد back-end متصلًا.

تشغيلها وإيقافها

لا يوجد مفتاح. يقرر ذلك إعداد واحد، NEXT_PUBLIC_API_BASE_URL، يُضمَّن عند بناء لوحة التحكم:

# empty or missing: the mock API, no back-end needed
NEXT_PUBLIC_API_BASE_URL=

# set: your API, the mock never runs
NEXT_PUBLIC_API_BASE_URL=http://localhost:8000/api

• من دون Docker، تعمل لوحة التحكم التي لا ملف .env لها على الواجهة التجريبية. أعد تشغيل yarn dev، أو نفّذ yarn build مرة أخرى، بعد تغيير القيمة.
• صورة Docker المبنية من دون --build-arg تعمل على الواجهة التجريبية. أما Docker Compose فيبني لوحة التحكم دائمًا بعنوان واجهة API.
• عندما يُوجَّه متصفح استخدم الواجهة التجريبية إلى واجهة API حقيقية، تتخلى لوحة التحكم عن الجلسة والبيانات النموذجية التي احتفظت بها، حتى لا يُرسل الطلب الأول برمز سترفضه واجهة API.

ما الذي يعمل عليها

تتأخر كل إجابة جزءًا من الثانية عمدًا، لتُرى حالات التحميل التي تأتي مع لوحة التحكم.

ابدأ من جديد

امسح بيانات الموقع لعنوان لوحة التحكم من إعدادات متصفحك، أو نفّذ هذا في وحدة تحكم المتصفح، فتعود البيانات النموذجية كما وصلت:

localStorage.removeItem("mock_db_v1"); location.reload();

أزلها

عندما تعمل على واجهة API الخاصة بك نهائيًا، احذف الواجهة التجريبية من الكود، في مجلد لوحة التحكم:

yarn remove:mock

يحذف src/lib/mock/ وإشعار البيانات النموذجية، ويزيل الكتل الموسومة بـ #region mock-api. وتحتاج لوحة التحكم بعد ذلك إلى ضبط NEXT_PUBLIC_API_BASE_URL. ويعيد كتابة الملفات ولا يمكن التراجع عنه من دون التحكم في الإصدارات، لذلك نفّذ commit أولًا.

• وضع العرض التجريبي وسكربتات الإزالة

كيف بُنيت