django rest starter kit

Kit de inicio del marco de descanso django

Esta es una plantilla de inicio para los proyectos de Django Rest Framework (DRF), diseñados para proporcionar una base sólida con características esenciales que se necesitan comúnmente en el desarrollo de API.

Características

• Autenticación basada en token : asegure los puntos finales de sus API utilizando la autenticación basada en token.
• Documentación de la API de Swagger : Genere automáticamente la documentación de API interactiva utilizando la interfaz de usuario de Swagger.
• Sistema de administración de usuarios : implementar las funcionalidades de registro de usuarios, inicio de sesión, inicio de sesión y restablecimiento de contraseña.
• Permisos y roles : Defina los roles y los permisos de los usuarios para controlar el acceso a los puntos finales de API.
• Notificaciones por correo electrónico : Configure las notificaciones de correo electrónico para eventos relacionados con el usuario como el registro y el reinicio de la contraseña.
• Limitación de la tasa : prevenir el abuso de puntos finales de API mediante la implementación de la limitación de tasas.
• Cargas de archivo : soporte de carga de archivos (por ejemplo, imágenes, documentos) con backends de almacenamiento personalizables.
• Aficionado al almacenamiento en caché : Mejore el rendimiento de la API con el almacenamiento en caché de los datos de acceso frecuente.
• Tareas de fondo : Realice tareas de fondo de forma asincrónica utilizando el apio y un corredor de mensajes.
• Monitoreo y registro : monitoree el rendimiento de la aplicación y rastree los errores con herramientas de registro y monitoreo.

Uso

1. Clon este repositorio:

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

2. Instalar dependencias:

   pip install -r requirements.txt

3. Configuración de personalización:

   • Configurar la configuración de la base de datos en settings.py .
   • Configure la configuración de correo electrónico para enviar notificaciones.
   • Configurar configuraciones de autenticación de token.
   • Personalice los permisos y roles de acuerdo con los requisitos de su aplicación.

4. Migrar la base de datos:

   python manage.py migrate

5. Ejecute el servidor de desarrollo:

   python manage.py runserver

6. Acceda a la documentación de la API:

   Abra su navegador y navegue a http://127.0.0.1:8000/swagger/ para ver la documentación de API interactiva generada por Swagger UI.

7. Comience a construir sus puntos finales de API:

   • Defina sus puntos finales de API en urls.py
   • Implemente vistas y serializadores para sus recursos de API en views.py y serializers.py respectivamente.
   • Asegure sus puntos finales utilizando la autenticación del token y defina los permisos según sea necesario.

Pruebas

Ejecutar pruebas unitarias y pruebas de integración para garantizar la confiabilidad y estabilidad de su API:

python manage.py test 

Que contribuye

¡Las contribuciones son bienvenidas! Si tiene sugerencias para mejoras o nuevas funciones, abra un problema o envíe una solicitud de extracción.

Licencia

Este proyecto tiene licencia bajo la licencia Apache -2.0; consulte el archivo de licencia para obtener más detalles.