django rest starter kit

Django Rest Framework Starter Kit

هذا هو قالب بداية لمشاريع Django Rest Framework (DRF) ، المصممة لتزويد أساس متين بميزات أساسية شائعة الشائعة في تطوير API.

سمات

• المصادقة المستندة إلى الرمز المميز : تأمين نقاط نهاية API الخاصة بك باستخدام المصادقة المستندة إلى الرمز المميز.
• وثائق API Swagger : قم بإنشاء وثائق API التفاعلية تلقائيًا باستخدام Swagger UI.
• نظام إدارة المستخدم : قم بتنفيذ وظائف تسجيل المستخدم ، تسجيل الدخول ، تسجيل الدخول ، وإعادة تعيين كلمة المرور.
• الأذونات والأدوار : تحديد أدوار المستخدم والأذونات للتحكم في الوصول إلى نقاط نهاية API.
• إشعارات البريد الإلكتروني : قم بإعداد إشعارات البريد الإلكتروني للأحداث المتعلقة بالمستخدمين مثل التسجيل وإعادة تعيين كلمة المرور.
• الحد من معدل : منع إساءة استخدام نقاط نهاية API عن طريق تنفيذ الحد من معدل.
• تحميل الملفات : تحميل ملفات الدعم (على سبيل المثال ، الصور ، المستندات) مع خلفية تخزين قابلة للتخصيص.
• التخزين المؤقت : تحسين أداء واجهة برمجة التطبيقات مع التخزين المؤقت للبيانات التي يتم الوصول إليها بشكل متكرر.
• مهام الخلفية : أداء مهام الخلفية بشكل غير متزامن باستخدام الكرفس ووسائط الرسائل.
• المراقبة والتسجيل : مراقبة أداء التطبيق وتتبع الأخطاء مع أدوات التسجيل والمراقبة.

الاستخدام

1. استنساخ هذا المستودع:

   git clone https://github.com/hossainchisty/django-rest-starter-kit.git

2. تثبيت التبعيات:

   pip install -r requirements.txt

3. تخصيص الإعدادات:

   • تكوين إعدادات قاعدة البيانات في settings.py .
   • قم بإعداد تكوين البريد الإلكتروني لإرسال الإخطارات.
   • تكوين إعدادات المصادقة الرمزية.
   • تخصيص الأذونات والأدوار وفقًا لمتطلبات طلبك.

4. ترحيل قاعدة البيانات:

   python manage.py migrate

5. قم بتشغيل خادم التطوير:

   python manage.py runserver

6. الوصول إلى وثائق API:

   افتح متصفحك وانتقل إلى http://127.0.0.1:8000/swagger/ لعرض وثائق API التفاعلية التي تم إنشاؤها بواسطة Swagger UI.

7. ابدأ في بناء نقاط نهاية واجهة برمجة التطبيقات الخاصة بك:

   • حدد نقاط نهاية API الخاصة بك في urls.py
   • قم بتنفيذ المشاهدات والمسلسلات لموارد API الخاصة بك في views.py serializers.py
   • تأمين نقاط النهاية الخاصة بك باستخدام مصادقة الرمز المميز وتحديد الأذونات حسب الحاجة.

الاختبار

قم بتشغيل اختبارات الوحدة واختبارات التكامل لضمان موثوقية واستقرار واجهة برمجة التطبيقات الخاصة بك:

python manage.py test 

المساهمة

المساهمات مرحب بها! إذا كانت لديك اقتراحات للتحسينات أو الميزات الجديدة ، فيرجى فتح مشكلة أو إرسال طلب سحب.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص Apache -2.0 - راجع ملف الترخيص للحصول على التفاصيل.