Essa API RESTful de uma escola foi desenvolvida para colocar em prática os conhecimentos adquiridos em Django Rest Framework.
- Interface Django Rest Framework:
- Interface Django Admin:
Essa API foi documentada através do Swagger e Redoc.
- Documentação Swagger:
# Url:
<localhost>/swagger
- Documentação Redoc:
# Url:
<localhost>/redoc
Para executar esse projeto é necessário seguir o passo a passo a seguir:
- Criar o ambiente virtual do Python.
Na pasta raíz do repositório local, execute o comando:
python -m venv <nome do ambiente virtual>
- Ativar o ambiente virutal
.\venv\Scripts\activate
- Instalar as dependências do requirements.txt.
pip install -r requirements.txt
- Executar as Migrations para preparar o banco de dados.
python manage.py migrate
- Executar os comandos a seguir para popular as tabelas do banco de dados utilizando dados Fake para testes.
# Popular tabela de cursos:
python popular_banco_cursos.py
# Popular tabela de estudantes:
python popular_banco_estudantes.py
- Executar o comando a seguir para ativar o servidor da aplicação Django:
python .\manage.py runserver
- Testes automatizados É possível realizar os teste automatizados desta API, sendo eles os testes unitários e os testes de integração que se encontram no diretório /tests
Para executar esses testes é necessário executar o comando a seguir:
python manage.py test
- Testes manuais
Para realizar os testes manuais dessa API, você poderá utilizar o Postman ou o Thunder Client:
Os links abaixo contém um suporte de como utilizar as ferramentas mencionadas: