Cadastro de Cliente e Contato

Sobre o projeto

Projeto prático que cria uma API REST de cadastro de clientes que permite vincular contatos. Gera relatório em PDF que mosta os Clientes e Contatos associados aquele.

DER

Kanban

Stacks

No projetos foram utilizadas as tecnologias, ferramentas e frameworks:

• Java 17
• Spring (Framework)
• Maven
• Swagger OpenAPI
• Banco H2 in memory
• JavaDoc
• HTML | CSS | Javascript (Frontend)
• Itext gerador PDF
• Postman
• Kanban github
• Github pages

Pré-requisitos

Antes de começar, você precisará ter o seguinte instalado em seu sistema:

• Java: (https://oracle.com/java/) (versão 17 ou superior)
• IDE: fica a seu critério (utilizei Intelli J)

Executando o backend

Siga as etapas abaixo para configurar e executar o backend:

1. Clone o repositório:

git clone [email protected]:alvescamila87/api-cadastro-cliente.git

2. Acesse o diretório do projeto:

cd api-cadastro-cliente

3. Ao abrir o projeto na IDE, execute o comando do Maven para limpar a instalar as dependências:

mvn clean install

4. Execute o projeto:

mvn spring-boot:run

Endpoints da API

BASE_URL: http://localhost:8080

O backend expõe as seguintes rotas da API:

Clientes

• GET /clientes
• GET /clientes/:id
• POST /clientes:
• PUT /clientes/:id
• DELETE /clientes/:id

Contatos

• GET /clientes/:idCliente:/Contatos
• GET /clientes/:idCliente:/Contatos/:id
• POST /clientes/:idCliente:/Contatos
• PUT /clientes/:idCliente:/Contatos/:id
• DELETE /clientes/:idCliente:/Contatos/:id

Relatorio

• GET /clientes/relatorio

Swagger

Pode ser utilizado o Swagger para check de documentação de API Rest e testes URL_SWAGGER: swagger-ui/index.html#/

Postman

A collection do Postman pode ser utilizada para os API Rest e testes também. Ela foi disponibilizada em:

resources > documentation > collection

Documentação

A documentação foi disponibilizada para facilitar a interação do usuário. JavaDoc

DER

Swagger OpenAPI

Collection Postman

Autor

• Camila Alves