🎯 Sobre a API

A API é capaz de realizar as operações para controle de clientes e funcionários e consumir a Api externa (ViaCEP) - verificando a incidência de cep(região).

📦 Desenvolvimento

Realizado com framework SpringBoot em Java 11, gestor de dependência com Maven - uso de DevTools para agilidade durante a produção de desenvolvimento. Hibernate e JPA para persistir os dados no banco de dados MySQL, Lombok para perfomance e diminuir boiler plate code. Auxílio do ModelMapper para criação do DTO. Flyway para migração e versionamento de Query (registro) para maior domínio sobre scripts SQL. Possibilidade de negociação de conteúdo (XML/JSON) com fasterxml e com interface amigável na documentação do projeto e dos devidos endpoints com Swagger.

💻 Requisitos de inicialização do projeto

Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento.

Consulte Implantação para saber como implantar o projeto.

📋 Pré-requisitos

De que coisas você precisa para instalar o software e como instalá-lo?

• Maven
• JDK

Unix

sudo apt install openjdk-11-jre-headless

📍 Rodando a aplicação

bash

 Clone este repositório
$ git clone https://github.com/Camargovf/Software-ViaCep

 Acesse a pasta do projeto no terminal/cmd
$ cd README-nomeprojeto

 Vá para a pasta nomeprojeto
$ cd project-nomeprojeto

 Instale as dependências
$ mvn install
$ mvn clean package

 Execute a aplicação em modo de desenvolvimento
$ javac -nomedoprojeto.jar

 O servidor iniciará na porta:8080 - acesse http://localhost:8080 \
 

✔️ Configurando Flyway

Primeiro coloque o flyway como: false. Após rodar o banco de dados e criar através do Springboot, apenas coloque a configuração para: true.

Seus scripts terão migrado!

mvn flyway:migrate

✔️ Vericando projeto ON

A tela da sua aplicação deve estar:

🧩 Consumindo API

CURL - Clientes

curl -X GET "http://localhost:8080/clientes" -H "accept: /"

CURL - Funcionários

curl -X GET "http://localhost:8080/funcionarios" -H "accept: /"

CURL - Adress (endereço)

curl -X GET "http://localhost:8080/adress" -H "accept: /"

📌 Documentação

A documentação foi realizada com Swagger com interface amigável para documentação e testes dos endpoints.

🔨 Funcionalidades do projeto

• Funcionalidade 1 salvarCliente: Cadastra um cliente com suas devidas informações no sistema.

• Funcionalidade 2 salvarFuncionario: Cadastra um funcionário e seu respectivo cargo no sistema.

• Funcionalidade 3 consumirEndereço: Utiliza api externa ViaCep.

• Funcionalidade 4 listafuncionario: Lista um funcionário por id.

• Funcionalidade 5 `listacliente: Lista um funcionário por id.

• Funcionalidade 6 paginasfuncionario: Lista um funcionário com a quantidade de páginas e quantidade de itens de cada página.

• Funcionalidade 7 atualizarFuncionario: Atualiza os dados refentes: funcionário.

• Funcionalidade 8 desligarFuncionario: Exclui um funcionário do sistema.

• Funcionalidade 9 verificaocorrencias: Verifica a incidências de cep iguais no sistema.

🛠️ Construído com as tecnologias

• Springboot
• Maven
• Lombok
• ModelMapper
• FasterXML
• FlyWay
• Swagger
• Hibernate
• MySQL
• DevTools

📚 Features em desenvolvimento

• Docker
• Flyway
• Deploy Google Cloud (GCP)
• TDD JUnit
• Spring Security

💪 Como contribuir com o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b nomedoarquivo
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "atualização"
4. Envie as suas alterações: git push origin nomedoarquivo

✒️ Desenvolvedor

Valdeir Camargo