django rest starter kit Téléchargement - django rest starter kit Source Code Téléchargement

django rest starter kit

Code Source AI

v1.21.0

Télécharger

Kit de démarrage du framework Django Rest

Il s'agit d'un modèle de démarrage pour les projets Django Rest Framework (DRF), conçu pour fournir une base solide avec des fonctionnalités essentielles généralement nécessaires dans le développement d'API.

Caractéristiques

Authentification basée sur les jetons : sécurisez vos points de terminaison API en utilisant l'authentification basée sur les jetons.
Documentation de l'API Swagger : générer automatiquement la documentation interactive de l'API à l'aide de l'interface utilisateur de Swagger.
Système de gestion des utilisateurs : implémentez les fonctionnalités d'enregistrement des utilisateurs, de connexion, de déconnexion et de réinitialisation du mot de passe.
Autorisations et rôles : définissez les rôles et autorisations utilisateur pour contrôler l'accès aux points de terminaison de l'API.
Notifications par e-mail : configurez les notifications par e-mail pour les événements liés à l'utilisateur tels que l'enregistrement et la réinitialisation du mot de passe.
Limitation des taux : empêcher la maltraitance des critères de terminaison de l'API en mettant en œuvre la limitation des taux.
Téléchargements de fichiers : Prise en charge des téléchargements de fichiers (par exemple, images, documents) avec des backends de stockage personnalisables.
Cache : améliorer les performances de l'API avec la mise en cache pour les données fréquemment accessibles.
Tâches d'arrière-plan : effectuez des tâches d'arrière-plan de manière asynchrone à l'aide de céleri et d'un courtier de messages.
Surveillance et journalisation : surveiller les performances de l'application et suivre les erreurs avec les outils de journalisation et de surveillance.

Usage

Cloner ce référentiel:

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

Installez les dépendances:
```
pip install -r requirements.txt
```
Personnaliser les paramètres:
- Configurer les paramètres de la base de données dans settings.py .
- Configurez la configuration des e-mails pour l'envoi de notifications.
- Configurez les paramètres d'authentification des jetons.
- Personnalisez les autorisations et les rôles en fonction des exigences de votre application.
Migrez la base de données:
```
python manage.py migrate
```
Exécutez le serveur de développement:
```
python manage.py runserver
```
Accéder à la documentation de l'API:
Ouvrez votre navigateur et accédez à http://127.0.0.1:8000/swagger/ pour afficher la documentation API interactive générée par Swagger UI.
Commencez à construire vos points de terminaison API:
- Définissez vos points de terminaison API dans urls.py
- Implémentez les vues et les sérialiseurs de vos ressources API dans views.py et serializers.py respectivement.
- Sécurisez vos points de terminaison en utilisant l'authentification des jetons et définissez les autorisations au besoin.

Essai

Exécutez des tests unitaires et des tests d'intégration pour assurer la fiabilité et la stabilité de votre API:

python manage.py test

Contributif

Les contributions sont les bienvenues! Si vous avez des suggestions d'améliorations ou de nouvelles fonctionnalités, veuillez ouvrir un problème ou soumettre une demande de traction.