الصفحة الرئيسية>المتعلقة بالبرمجة>بايثون
تنزيل

مشروع الواجهة الخلفية Laravel/PHP

رابط لبناء الإنتاج المباشر

مرحبًا بك في أحد مشاريع API الأخرى. بالنسبة لهذا المشروع، قمت بكتابة واختبار ونشر تطبيق Laravel كجزء من مشروع متكامل، مع الاستفادة من العديد من الميزات القوية لإطار العمل بما في ذلك:

  • الواجهات والوظائف المساعدة؛
  • مصادقة المستخدم والترخيص؛
  • زرع قاعدة البيانات؛
  • منشئ استعلام ORM البليغ؛
  • أدوات اختبار API المتقدمة.

ما الغرض منه؟

تعالج واجهة برمجة التطبيقات هذه البيانات المتعلقة بالمستخدمين/المرشحين وامتحاناتهم. على سبيل المثال، يسمح للمستخدم بعرض معلومات حول أماكن/مواقع الامتحانات والتواريخ وأسماء المرشحين وما إلى ذلك.

ملاحظة هامة بشأن الوصول

  • تأكد من تضمين قبول: application/json رأس HTTP مع جميع الطلبات المقدمة إلى واجهة برمجة التطبيقات.
  • معظم ميزات واجهة برمجة التطبيقات متاحة فقط للمستخدمين على مستوى المشرف. لتجربة هذا التطبيق، يمكنك التسجيل للحصول على حساب جديد باستخدام بريد إلكتروني ينتهي بـ @v3.admin والذي سيمنحك امتيازات المسؤول الكاملة. 
 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

بمجرد قيامك بالتسجيل أو تسجيل الدخول، سيتم إصدار رمز مميز لواجهة برمجة التطبيقات (API) لك والذي يجب إرفاقه برؤوس طلبك لضمان الوصول الكامل إلى CRUD.

نقاط النهاية المتاحة

للوصول إلى كل نقطة نهاية، قم بإلحاق جزء URI بنقطة النهاية الجذرية. يمكنك عرض المزيد من التفاصيل من خلال زيارة نقطة النهاية الجذرية.

الموارد وصف المصادقة/الترخيص
نشر / الاشتراك إنشاء حساب جديد. عام
مشاركة / تسجيل الدخول يدخل إلى الحساب الحالي. عام
الحصول على /تسجيل الخروج/{id} تسجيل الخروج (يلغي الرموز المميزة). المستخدمين الذين قاموا بتسجيل الدخول فقط
الحصول على / الامتحانات تظهر قائمة بجميع الامتحانات. يتضمن 5 معلمات استعلام اختيارية . المشرف فقط
الحصول على / الامتحانات / {معرف} الحصول على امتحان محدد. يمكن أن نرى فقط الامتحانات الخاصة
وضع / الامتحانات / {معرف} تعديل امتحان معين. يمكن فقط تعديل الاختبارات الخاصة
الحصول على / الامتحانات / البحث / {الاسم} البحث عن سلسلة فرعية لمرشح محدد. المشرف فقط
حذف /الامتحانات/{المعرف} حذف الامتحان. يمكن حذف الامتحان الخاص فقط
الحصول على / المستخدمين الحصول على قائمة بجميع المستخدمين. المشرف فقط
الحصول على /users/{id}/exams الحصول على قائمة بجميع الاختبارات للمستخدم يمكن أن نرى فقط الامتحانات الخاصة

ميزات المنتج الرئيسية

  • تم نشرها على Vercel باعتبارها "وظيفة بدون خادم"، وذلك باستخدام وقت تشغيل PHP للتعامل مع تكوين التطبيقات.
  • يرتبط نشر الإنتاج بقاعدة بيانات PSQL مباشرة يتم استضافتها عن بعد مع موفر مختلف.
  • بناء جملة معبر خاص بـ Laravel مع تسلسل طرق واسع النطاق، مما يسمح ببنية تعليمات برمجية أكثر إيجازًا.
  • تم تطويره بطريقة مبنية على الاختبار باستخدام PHPUnit وصيغة JSON بطلاقة من Laravel (استنادًا إلى عمليات الإغلاق وفئة AssertableJson).
  • اختبار تلقائي باستخدام سير عمل CI/CD تم تكوينه باستخدام Github Actions.
  • تم تصميمه باستخدام نمط MVC موجه للكائنات
  • خدمات المصادقة المنفذة باستخدام Sanctum
    • يمكن للمستخدمين التسجيل وتسجيل الدخول.
    • لا يمكن الوصول إلى المسارات المحمية إلا للمستخدمين الذين لديهم رموز API صالحة.
  • يتم تنفيذ خدمات الترخيص باستخدام بوابات Laravel، وهو نهج قائم على الإغلاق للترخيص.
    • يُسمح بإجراءات معينة فقط للمستخدمين ذوي الأدوار المحددة، مثل حالة المسؤول.
  • تم تعريف قيود العلاقات والمخطط باستخدام أدوات علاقات Eloquent ORM
  • قاعدة بيانات SQLite تستخدم للتطوير والاختبار.

الملفات والمجلدات الرئيسية في دليل المشروع

  • يحتوي ./app على المنطق الأساسي للتطبيق.
    • يحتوي /app/Http/Controllers على منطق معالجة الطلب.
    • يحتوي التطبيق/النماذج على جميع فئات النماذج وهو المكان الذي نحدد فيه جميع الحقول القابلة للتعبئة.
    • يحتوي التطبيق/الموفرون على فئات تعمل على تمهيد التطبيق بأكمله.
  • ./routes/api.php هو المكان الذي نحدد فيه بإيجاز جميع مساراتنا (نقاط النهاية).
  • يحتوي ./tests/Feature على جميع اختبارات التكامل الخاصة بالتطبيق.
  • ./config/database.php يسمح لك بتكوين إعدادات اتصال قاعدة البيانات الخاصة بك.
  • ./database هو مجلد آخر مهم جدًا.
    • يحتوي ./database/factories على فئات المصنع المستخدمة لبذر قواعد البيانات.
    • ./database/migrations يسمح لنا بتعديل نموذج البيانات الخاص بنا
    • يحتوي ./databse/seeders على فئات تقوم بزرع قاعدة البيانات عبر المصانع.

تشغيل المشروع في بيئتك المحلية

أولاً، تأكد من تثبيت PHP وComposer على جهازك.

الحد الأدنى لمتطلبات الإصدار: PHP ^8.1 ؛ الملحن 2.5.4 .

  1. شوكة واستنساخ المستودع.

  2. cd في المستودع وقم بتشغيل أوامر CLI هذه: 

     composer update
 composer install

  3. أعد تسمية ملف .env.example الخاص بك إلى .env ، وقم بإزالة المتغيرات الخاصة باتصال mysql الافتراضي، وتأكد من إضافة المتغيرات الثلاثة التالية: 

     DB_CONNECTION=sqlite
 DB_FOREIGN_KEYS=true
 USE_SQLITE_SYNTAX=like
 DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*

  4. لتشغيل خادم التطوير المحلي، قم بتشغيل أمر Artisan CLI: 

     php artisan serve

  5. لتشغيل بدلة الاختبار، قم بتشغيل أمر Artisan CLI: 

     php artisan test

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل