o projeto depende do Poetry para seu gerenciamento e precisa ser devidamente instalado e configurado.
Para instalar o poetry execute em ordem os comandos:
pip install --user pipx
pipx install poetry
poetry python install 3.13
poetry env use 3.13
poetry install
poetry self add poetry-plugin-shell
Para ativar o ambiente:
poetry shell
O projeto se utiliza da ferramenta task para criar scripts com os comandos fundamentais que podem ser vistos abaixo:
task run
Executa o projeto da api localmente equivalente ao comando python manage.py runserver.task migrations
Gera os arquivos de migração, equivalente ao comando python manage.py makemigrationstask migrate
Aplica as migrações. equivalente ao comando python manage.py migratetask test
Executa os testes automatizados.
Para autenticar e obter os tokens de acesso e refresh, realizar uma requisição POST para http://localhost:8000/api/token/
O body deve ser no formato json
{
"username": "username" ,
"password": "password"
}
Se o usuario for autenticado corretamente a saida deve ser um json contendo dois tokens
{
"refresh": "TOKEN",
"access": "TOKEN"
}
swagger
As rotas e os testes da API podem ser acessados via Swagger no link: http://localhost:8000/swagger/
Para autenticação, use o botão Authorize e informe o token válido no formato abaixo:
Bearer SEU_TOKEN
redoc
A página da documentação da API pode ser acessada via Redoc no link: http://localhost:8000/redoc/