Esse projeto é uma API REST para gerenciar alunos de uma escola
É bem simples executar esse projeto, basta você seguir esses passos:
- Copiar .env.example para .env com as variáveis de ambiente, você pode usar o comando:
cp .env.example .env
- Fazer o build dos containers com o comando:
docker-compose up -d --build
- REST
- Soft delete
- golang_app
- postgres
- pgadmin-compose
-
GET /alunos
Retorna a lista de alunos -
GET /alunos/{ID}
Retorna as informações de um aluno -
POST /alunos
Cria um aluno, exemlo de json a ser enviado no body:{ "nome": "Daniel", "cpf": "23034153066", "rg": "140535925", "matricula": "120931" }
-
PATCH /alunos/{ID}
Edita os dados de um aluno, exemlo de json a ser enviado no body:{ "nome": "Daniel test", }
Observação: note que por ser usado o método
PATCH
, não é necessário enviar todos os dados do recurso aluno, apenas os campos que deseja editar -
DELETE /alunos/{ID}
Deleta um aluno -
GET /alunos/busca/{CPF}
Busca as informações de um aluno pelo CPF