django rest starter kit

Django Rest Framework Starter Kit

Este é um modelo de partida para projetos de Rest Django (DRF), projetados para fornecer uma base sólida com recursos essenciais comumente necessários no desenvolvimento da API.

Características

• Autenticação baseada em token : proteja seus terminais de API usando autenticação baseada em token.
• Documentação da API de Swagger : Gere automaticamente a documentação da API interativa usando a interface do usuário do Swagger.
• Sistema de gerenciamento de usuários : implemente as funcionalidades de registro, login, logout e redefinição de senha.
• Permissões e funções : Defina funções e permissões do usuário para controlar o acesso a pontos de extremidade da API.
• Notificações por email : Configure notificações de email para eventos relacionados ao usuário, como registro e redefinição de senha.
• Limitação da taxa : impedir o abuso de pontos de extremidade da API implementando a limitação da taxa.
• Uploads de arquivos : uploads de arquivo de suporte (por exemplo, imagens, documentos) com backnds de armazenamento personalizáveis.
• Cache : Melhore o desempenho da API com armazenamento em cache para dados frequentemente acessados.
• Tarefas de segundo plano : execute tarefas em segundo plano usando assíncrono usando o aipo e um corretor de mensagens.
• Monitoramento e log : monitore o desempenho do aplicativo e rastreie erros com ferramentas de registro e monitoramento.

Uso

1. Clone este repositório:

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

2. Instale dependências:

   pip install -r requirements.txt

3. Personalize Configurações:

   • Defina as configurações do banco de dados em settings.py .
   • Configure a configuração de email para enviar notificações.
   • Configurar configurações de autenticação de token.
   • Personalize permissões e funções de acordo com os requisitos do seu aplicativo.

4. Migrar o banco de dados:

   python manage.py migrate

5. Execute o servidor de desenvolvimento:

   python manage.py runserver

6. Acesse a documentação da API:

   Abra seu navegador e navegue para http://127.0.0.1:8000/swagger/ para visualizar a documentação da API interativa gerada pela Swagger UI.

7. Comece a construir seus pontos de extremidade da API:

   • Defina seus pontos de extremidade da API em urls.py
   • Implementar visualizações e serializadores para seus recursos da API em views.py e serializers.py , respectivamente.
   • Prenda seus pontos de extremidade usando autenticação de token e defina permissões conforme necessário.

Teste

Execute testes de unidade e testes de integração para garantir a confiabilidade e a estabilidade da sua API:

python manage.py test 

Contribuindo

As contribuições são bem -vindas! Se você tiver sugestões de melhorias ou novos recursos, abra um problema ou envie uma solicitação de tração.

Licença

Este projeto está licenciado sob a licença Apache -2.0 - consulte o arquivo de licença para obter detalhes.