tiagofrancarita / folha-pagamento

API folha-pagamento Feign, Ribbon, Hystrix, OAuth, JWT, Discovery Server Eureka, API Gateway Zuul, Config Server

API - FOLHA de Pagamento

Este projeto é uma aplicação de folha de pagamento desenvolvida em Java 11, utilizando o banco de dados PostgreSQL e documentada com Swagger. Além disso, a API pode ser testada e explorada através do Postman.

Requisitos

Certifique-se de ter as seguintes ferramentas instaladas em seu ambiente de desenvolvimento:

• Java 11 ou superior
• PostgreSQL 9.5.2
• Postman (ou similar) para realizar teste de requisições da API
• Feign
• API-GATEWAY

Configuração do Banco de Dados

Certifique-se de ter as seguintes ferramentas instaladas em seu ambiente de desenvolvimento:

1. Instale o PostgreSQL em sua máquina e certifique-se de que o serviço esteja em execução.
2. Crie um banco de dados chamado "BDESSH01" usando o cliente PostgreSQL de sua preferência.
3. Certifique-se de que todas as dependências do projeto tenham sido baixadas corretamente.
4. As configurações de conexão do banco de dados podem ser ajustadas no arquivo application-dev.properties na pasta src/main/resources.

spring.datasource.url = localhost
spring.datasource.username = SeuUsuario
spring.datasource.password = SuaSenha
spring.jpa.hibernate.ddl-auto = none
spring.sql.init.platform = postgres
spring.datasource.driver-class-name = org.postgresql.Driver
spring.jpa.show-sql = true

Executando a Aplicação

1. Clone este repositório para o seu ambiente local. [REPOSITORIO] (https://github.com/tiagofrancarita/folha-pagamento)
2. Abra o projeto em uma IDE java de sua preferência.
3. Certifique-se de que todas as dependências do projeto tenham sido baixadas corretamente.
4. Execute a aplicação através do método main na classe principal Application.java.

Documentação da API

A API da aplicação de folha de pagamento está documentada usando o Swagger, o que facilita a visualização e teste dos endpoints disponíveis. Para acessar a documentação da API, inicie a aplicação e abra o seguinte link em seu navegador web:

  http://localhost:8080/swagger-ui.html

Testando a API

Você pode testar a API utilizando o Postman (ou uma ferramenta similar) para enviar requisições HTTP aos endpoints da aplicação.

1. Abra o Postman em seu computador.
2. Importe a coleção de requisições disponível em postman/.
3. Com a aplicação em execução, envie as requisições para testar os diferentes endpoints da API.

Contribuindo

Contribuições são bem-vindas! Se você encontrar algum problema ou tiver sugestões para melhorias, sinta-se à vontade para abrir uma issue ou enviar um pull request.

Licença

Este projeto está licenciado sob a licença MIT. Sinta-se livre para usar, modificar e distribuir o código conforme as diretrizes desta licença. MIT

Etiquetas