django_restful_api

Projeto feito para o desafio da Medclub de criar uma API RESTful que gerencie usuários, pedidos e itens.

Como configurar e executar este projeto em sua máquina

Executando via Docker

1 - Criar e executar a imagem, container Docker

Caso queria executar esse projeto usando Docker você precisará seguir apenas alguns passos simples.
Construindo a imagem com base no arquivo Dockerfile disponivel nos arquivos do projeto.

docker build -t django_restful_api .

Criando o contêiner com base na imagem 'django_restful_api'.

docker create --name django_restful_api_container -p 8000:8000 django_restful_api

Inicializando o container docker.

docker start <id_container>

Com isso você executou facilmente este projeto.
Lembrando que ainda será interessante criar um super usuário para ter acesso a todas as funcionalidades e rotas da API.

2 - Criar super usuário via bash do container Docker

Para acessa o bash do seu container docker e criar seu primeiro super usuário execute os seguintes comandos:

docker exec -it <id_container> bash
cd django_restful_api/
python manage.py createsuperuser

Em seguida você irá preencher alguns campos básicos para criação do seu primeiro usuário.

Executando diretamente na máquina local

1 - Clonar o projeto

Usando o terminal/bash da sua preferência execute o seguinte comando git:

git clone https://github.com/EnzoBelem/django_restful_api.git

2 - Criar e configurar o ambiente virtual

2.1 - Versão do python

Este projeto foi desenvolvido na versão 3.10.11 do Python.

2.2 - Criando o ambiente virtual

Dentro da pasta do projeto execute o seguinte comando:

• Windows

python -m venv venv

• Linux

python3.10 -m venv venv

2.3 - Dificuldades com a versão do Python no Windows

Caso seu sistema já possua alguma versão do Python instalada alguns problemas podem surgir. Verifique se a versão 3.10.11 é a versão global do Python, caso não seja aqui vão algumas dicas importantes:

• Verifique e altere as variáveis de ambiente do Python no seu sistema.
• Crie o ambiente usando o caminho direto para a versão 3.10.11:

C:\Users\usuario\AppData\Local\Programs\Python\Python310\python.exe -m venv venv

2.4 - Configurando o ambiente virtual

Agora precisamos instalar todos os pacotes necessários para executar o projeto de forma correta.
Com seu terminal/bash aberto dentro da pasta do projeto inicie o ambiente virtual com o seguinte comando:

• Windows

.\venv\Scripts\activate

• Linux

source venv/bin/activate

Agora precisamos instalar os seguintes pacotes:

pip install django
pip install djangorestframework

3 - Migrações do projeto

Agora que temos nosso ambiente virtual criado e configurado, precisamos realizar as migrações necessárias para configurar o banco de dados.
Com o seu ambiente virtual executando vá para a pasta do projeto Django e execute o seguinte comando:

python manage.py migrate

4 - Criar um super usuário:

Esta API trabalha com requisições com autenticação, por este motivo caso você não tenha um usuário criado a maioria das rotas da APi será bloqueada. Você pode contornar este problema criando um super usuário diretamente pelo terminal/bash.
Execute o seguinte comando:

python manage.py createsuperuser

Em seguida você irá preencher alguns campos básicos para criação do seu primeiro usuário.

5 - Executar o projeto

Nessa etapa todas as configurações já foram feitas e basta executar o projeto usando o seguinte comando:

python manage.py runserver

O projeto será executado na porta padrão 8000.

System check identified no issues (0 silenced).
June 08, 2023 - 18:35:38
Django version 4.2.1, using settings 'django_restful_api.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

Agora você pode usar a API como quiser, lembrando que a documentação completa do projeto se encontra no arquivo DOCS.md.