weevely api

؟ التنزيلات

• v1.0 الأحدث - تنزيل

⚓ المتطلبات

• PHP 8.0.7
• MySQL 6.x / Mariadb 10.x
• الملحن 2.x

تثبيت MacOS:
يمكنك بسهولة تثبيت هؤلاء عبر Homebrew:

brew install php mysql composer

تثبيت Windows:

1. قم بتنزيل وتثبيت أحدث إصدار من XAMPP. سوف يثبت لك كل من PHP و MariaDB. كلما أردت استخدام قاعدة البيانات الخاصة بك ، افتح XAMPP وبدء عملية MySQL. للوصول إلى phpmyadmin ، ابدأ كل من عمليات Apache و MySQL ، انقر فوق زر المسؤول بجوار MySQL
2. قم بتنزيل وتثبيت أحدث إصدار من الملحن. مدير التبعية PHP.

؟ تشغيل API محليا

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

لاستضافة واجهة برمجة التطبيقات فقط اتبع هذه الخطوات:

1. تحقق من المتطلبات ☝
2. قم بتنزيل أحدث إصدار
3. افتح المجلد في المحطة الطرفية وتركيب composer install
4. قم بإنشاء database الخاصة بك
5. قم بإنشاء ملف .env واملأه ببياناتك وفقًا لملف .env.example
6. قم بتشغيل php artisan migrate لملء قاعدة البيانات مع الجداول المطلوبة
7. إذا كنت ترغب في إضافة بعض البيانات إلى قاعدة البيانات للاختبار ، قم بتشغيل php artisan db:seed
8. ابدأ خادم API مع php artisan serve

؟ مرجع API

وحدة التخويل

فعل	طلب	طريقة	متطلبات
يسجل	/api/auth/register	POST	بيانات
تسجيل الدخول	/api/auth/signin	POST	بيانات
تسجيل الخروج	/api/auth/signout	POST	رمز حامل
إعادة تعيين كلمة المرور	/api/auth/reset-password	POST	بيانات
تغيير كلمة المرور	/api/auth/reset-password/{token}	POST	البيانات ، الرمز المميز
إزالة الطلب	/api/auth/reset-password/{token}/remove	GET	رمز
رمز تحديث	/api/auth/refresh	GET	رمز حامل
احصل على المستخدم	/api/auth/me	GET	رمز حامل

وحدة المستخدم

فعل	طلب	طريقة	متطلبات
تحديث البيانات	/api/users/me	PATCH	رمز حامل ، البيانات
تحميل الصورة الرمزية	/api/users/me/avatar	POST	رمز حامل ، البيانات

وحدة التقويمات والأحداث

أكشن	طلب	طريقة	متطلبات
احصل على التقويمات الخاصة بي	/api/calendars/my/{type}	GET	رمز حامل ، اكتب
إنشاء التقويم	/api/calendars/my	POST	رمز حامل ، البيانات (اختيارية)
احصل على التقويم	/api/calendars/{calendar_id}	GET	رمز حامل ، Calendar_id
تحديث التقويم	/api/calendars/{calendar_id}	PATCH	رمز حامل ، Calendar_id ، البيانات
حذف التقويم	/api/calendars/{calendar_id}	DELETE	رمز حامل ، Calendar_id
مشاركة التقويم	/api/calendars/{calendar_id}/share	POST	رمز Bearer ، Calendar_id ، المستخدمون (سلسلة JSON)
إخفاء التقويم	/api/calendars/{calendar_id}/hide	POST	رمز حامل ، Calendar_id
احصل على الأحداث	/api/calendars/{calendar_id}/events	GET	رمز حامل ، Calendar_id
إنشاء حدث	/api/calendars/{calendar_id}/events	POST	رمز حامل ، Calendar_id ، البيانات (اختياري)
تحديث الحدث	/api/calendars/{calendar_id}/events/{event_id}	PATCH	رمز حامل ، Calendar_id ، البيانات
حذف الحدث	/api/calendars/{calendar_id}/events/{event_id}	DELETE	رمز حامل ، Calendar_id
إضافة العطلات	/api/calendars/{calendar_id}/holidays	POST	رمز حامل ، Calendar_id ، البيانات (البلد ، السنة)

؟ أتمنى لك يوماً عظيماً!

لا تنسَ أن نتحقق من السوسة مع Next.js
تحقق أيضًا من مشاريعي الأخرى وزيارة موقع الويب الخاص بي!