Sobre • Como Executar • Como Executar Testes • Como Visualizar o Swagger •
API de Produção.
Um makefile é disponibilizado para ajudar com algumas atividades rotineiras, para checar a lista de receitas disponíveis, basta acessar o makefile aqui ou simplesmente, na raiz do projeto, executar o comando make help.
Execute make build-all e em seguida make run-all, para executar todas as imagens necessárias e subir o projeto localmente. Caso deseje executar somente o banco de dados, é possível através da receita make run-db (também após o make build-all).
Esse projeto atualmente possui testes unitários e de integração, para executar todos, é necessário que ao menos o container do banco de dados esteja disponível (para saber como, veja a seção: Como Executar).
Execute o seeds: make db-reset
Após isso, basta executar o comando make test, que fará com que a base de dados atual seja recriada (para execução dos testes de integração) e os testes sejam executados.
Este projeto conta com Swagger para especificação e documentação da API. Para visualizar, basta executar localmente o projeto, como indicado na seção Como Executar. E então acessar o link abaixo:
http://localhost:8000/swagger/index.html