lucasfroque / TrackMe

TrackMe

APIRest que permite cadastrar, buscar, atualizar e deletar um funcionário.

🛠 Tecnologias utilizadas

• Java 17
• Maven
• Springboot
• Spring Data JPA
• H2 Database
• Swagger
• PostgreSQL
• Junit/Mockito
• Github actions

🔗 Links

• API URL: http://teste-tracknme.herokuapp.com/funcionarios
• SWAGGER DOCUMENTATION: http://teste-tracknme.herokuapp.com/swagger-ui/index.html#/

💻 Funcionalidades

• Integração total com o Spring Framework mais recente para o desenvolvimento da API.
• Um banco de dados na memória (H2) para armazenar os dados para fins de testes.
• Testes unitários com Junit/Mockito.
• Heroku Cloud para fazer deploy da API.
• CI/CD utilizando Github actions para compilar, testar e fazer deploy na cloud(HEROKU) sempre que houver alteração na branch master.
• RestTemplate para consumir a API externa(Viacep) e utilizar seus dados.
• Swagger para "autodocumentar" toda API.

Rodando localmente

Clone o projeto

  git clone https://github.com/lucasfroque/TracknMe-teste

Entre no diretório do projeto

  cd TracknMe-teste

Instale as dependências

  mvn clean install

Inicie o servidor

  mvn spring-boot:run

Rodando os testes

Para rodar os testes, rode o seguinte comando

  mvn test

Documentação da API

Cria um novo funcionario

  POST /funcionarios

Retorna todos os funcionarios

  GET /funcionarios

Retorna um funcionario

  GET /funcionarios/${id}

Parâmetro	Tipo	Descrição
id	long	Obrigatório. O ID do funcionario que você quer

Retorna todos os funcionarios com o CEP específico

  GET /funcionarios/cep/${cep}

Parâmetro	Tipo	Descrição
id	string	Obrigatório. O CEP que você quer

Atualiza um funcionario

  PUT /funcionarios/${id}

Parâmetro	Tipo	Descrição
id	long	Obrigatório. O ID do funcionario que você quer

Deleta um funcionario

  DELETE /funcionarios/${id}

Parâmetro	Tipo	Descrição
id	long	Obrigatório. O ID do funcionario que você quer