🎯 Sobre o projeto

O projeto é capaz de registrar valores referentes à remunerações dos funcionários, com os devidos descontos na folha de pagamento. Com validade legal para comprovação de renda e atividade remunerada. O documento tem função contábil e fiscal, além de sua importância operacional.

📦 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. 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.

📋 Diagrama UML

💻 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/RestAPI-Folha-de-Pagamento

 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 

✔️ Vericando projeto ON

A tela da sua aplicação deve estar:

🧩 Consumindo API

CURL - cargos

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

CURL - funcionários

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

CURL - pagamento

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

💼 Negociação de Conteúdo

A aplicação pode ser consumida em XML e em JSON.

Modelo XML

Modelo schema json

📌 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 salvarCargo: Cadastra um cargo com suas devidas informações no sistema.

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

• Funcionalidade 3 gerarFolha: Cadastra a folha de pagamento relacionado a um funcionário no sistema.

• Funcionalidade 4 buscarPagamento: Lista um funcionário por nome.

• Funcionalidade 5 folhaPagamento: Lista um funcionário por matrícula.

• Funcionalidade 6 atualizarFuncionario: Atualiza os dados refentes: cargo, funcionário e folha de pagamento.

• Funcionalidade 7 desligarFuncionario: Desativa um funcionário do sistema de pagamento.

🛠️ Construído com as tecnologias

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

📚 Features em desenvolvimento

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

💪 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

🎁 Considerações Finais

• Agradecimento:
• A squad pelo trabalho incrível, conhecimentos adquiridos durante a jornada da Academia.
• A Gama Academy, instrutora Marianne e supervisora Débora.
• A CERC pelo ambiente gerado e maestria do onboarding.

✒️ Desenvolvedores

Bruno Brito	Gabriel Moreira	Laerson	Leonardo	Marcklen Guimarães	Valdeir Camargo