Esta API RESTful, desenvolvida para a empresa de confecção Lu Estilo, utiliza o framework FastAPI para proporcionar um gerenciamento eficiente. O sistema oferece funcionalidades para administração de perfis de clientes e administradores, além do controle de produtos e pedidos. Com ele, é possível listar, consultar e gerenciar o estoque de forma prática e intuitiva.
Para executar o projeto, certifique-se de que sua máquina possui as seguintes ferramentas:
Passo a passo:
git clone https://github.com/alcides07/lu-estilo.git
cd lu-estilo/api
SECRET_KEY=unsafe_secret
DATABASE_URL=postgresql://lu:123@db:5432/lu-db
POSTGRES_USER=lu
POSTGRES_PASSWORD=123
POSTGRES_DB=lu-db
docker-compose -f docker-compose-dev.yml up --build
A API possui documentação de todas as suas rotas, incluindo exemplos e cenários de erro previstos, proporcionando o maior suporte possível.
http://localhost:8000/docs/
Você vai se deparar com:
POST
http://localhost:8000/auth/register/
Realize o login pelo botão Authorize no canto superior direito.
Associe-se como cliente (POST /clients/) ou administrador (POST /administrators/). Caso deseje, é possível vincular-se a ambos os perfis simultaneamente, acumulando suas respectivas permissões
Após a associação, para acessar todas as funcionalidades corretamente, realize logout e faça login novamente para que suas permissões sejam atualizadas conforme seu novo papel
A utilização do Make nesse caso serve apenas para simplificar o processo de execução. Nos bastidores, quem realiza a tarefa é o docker-compose.
make full-dev
Os testes foram desenvolvidos utilizando as ferramentas pytest, factory-boy e faker, que auxiliam na criação de objetos fictícios conforme necessário, proporcionando a construção automatizada dos cenários de teste.
Você pode executar os testes utilizando qualquer um dos seguintes comandos:
docker exec -it lu-api-dev pytest | make test
Sentry é uma plataforma para rastrear, gerenciar e corrigir erros em aplicações.
A configuração foi integrada ao projeto e requer a definição da variável de ambiente {SENTRY_DSN} em um arquivo .env, obtida a partir da sua conta em Sentry.
Para deploy da aplicação, utilizou-se o arquivo Dockerfile (não Dockerfile.dev) disponível no repositório em conjunto da plataforma Render para hospedagem da API da Lu Estilo, e a plataforma Supabase para o banco de dados, ambos em planos gratuitos.
A API está disponível em https://lu-estilo.onrender.com/ e pode ser acessada livremente para testes e manipulações desejadas.
A interface de administração em http://localhost:8000/admin/ está acessível sem necessidade de autenticação, permitindo a visualização rápida de determinados itens. No entanto, alguns modelos aninhados podem não estar totalmente configurados e apresentar inconsistências.