REPOSITORY OVERVIEW

Live repository statistics

★ 1Stars

⑂ 0Forks

◯ 0Open issues

◉ 1Watchers

README preview

ClienteServer - Microserviço de Gerenciamento de Clientes

Este projeto é um microserviço desenvolvido com Spring Boot para gerenciar informações de clientes. Ele utiliza MongoDB como banco de dados e oferece uma API RESTful para realizar operações de cadastro, consulta, atualização e remoção de clientes.

Funcionalidades

Cadastro de Clientes: Permite cadastrar novos clientes com nome, CPF e telefone.
- Validação de dados: Garante que os campos obrigatórios (nome e CPF) estejam preenchidos.
Consulta de Clientes:
- Listar Todos os Clientes: Retorna todos os clientes cadastrados, com suporte a paginação e ordenação.
- Buscar por ID: Retorna um cliente específico pelo seu identificador único.
- Buscar por CPF: Retorna um cliente específico pelo seu CPF.
- Verificar Cadastro por ID: Verifica se um cliente estcadastrado pelo seu ID.
Atualização de Clientes: Permite atualizar os dados de um cliente existente, incluindo nome, CPF e telefone.
- Validação de dados: Garante que os campos obrigatórios (nome e CPF) estejam preenchidos.
Remoção de Clientes: Permite remover um cliente pelo seu ID.
Validação de Dados: Garante a integridade dos dados, verificando se os campos obrigatórios estão preenchidos e se os formatos são válidos.
Documentação OpenAPI: Gera automaticamente a documentação da API, facilitando a integração e o entendimento.

Tecnologias Utilizadas

Java 22+: Linguagem de programação.
Spring Boot: Framework para desenvolvimento rápido de aplicações Java.
Spring Data MongoDB: Simplifica o acesso ao MongoDB.
MongoDB: Banco de dados NoSQL.
Lombok: Reduz o código boilerplate (ex: getters, setters, construtores).
Jakarta Validation: Para validação de dados (ex: @NotNull).
SpringDoc OpenAPI: Para geração automática da documentação da API (Swagger).
Maven: Gerenciador de dependências.

Pré-requisitos

Java JDK 22+
Maven
MongoDB instalado e em execução na porta padrão (27017).

Configuração

MongoDB:
- Certifique-se de que o MongoDB esteja instalado e rodando na sua máquina.
- O projeto se conecta ao banco de dados MicroServico no localhost:27017.
- Você pode alterar essas configurações no arquivo src/main/java/br/com/lfrank/config/MongoConfig.java se necessário.
  - getDatabaseName(): Define o nome do banco de dados.
  - mongoClient(): Define a url de conexão com o banco de dados.
Configurações do Projeto:
- O projeto utiliza as seguintes classes de configuração:
  - src/main/java/br/com/lfrank/config/MongoConfig.java: Configura a conexão com o MongoDB.
  - src/main/java/br/com/lfrank/config/OpenAPIConfig.java: Configura a documentação OpenAPI (Swagger).
    - customOpenAPI(): Define o nome da aplicação, versão, descrição, termos de serviço, licença e contato.
  - src/main/java/br/com/lfrank/config/ValidatorConfig.java: Configura o validador de dados.
    - validatorFactory(): Define o validador a ser usado.
  - src/main/resources/application.properties: Arquivo de configuração da aplicação.
    - application-version: Define a versão da aplicação.

Como Executar

Clone o Repositório: bash git clone https://github.com/LucasFrank99/ProjetoMicroservicos
Navegue até o Diretório do Projeto: bash cd ExercicioMicroserviçosMod42/ClienteServer
Execute com Maven: bash mvn spring-boot:run
Acesse a API:

A API estará disponível em http://localhost:8080/.

Como Usar

Endpoints

POST /cliente
- Descrição: Cadastra um novo cliente.
- Corpo (JSON): json { "nome": "Nome do Cliente", "cpf": 12345678900, "telefone": 11987654321 }
- Retorno: O cliente cadastrado (JSON) com o id gerado.
- Validações: O nome e o CPF são obrigatórios.
GET /cliente
- Descrição: Busca todos os clientes (com paginação e ordenação).
- Parâmetros (Opcionais):
  - page: Número da página (começa em 0).
  - size: Tamanho da página.
  - sort: Critério de ordenação (ex: nome,asc ou cpf,desc).
- Exemplo: GET /cliente?page=0&size=10&sort=nome,asc
- Retorno: Uma página de clientes (JSON).
GET /cliente/{id}
- Descrição: Busca um cliente pelo ID.
- Parâmetros:
  - id: ID do cliente.
- Retorno: O cliente encontrado (JSON).
GET /cliente/cpf/{cpf}
- Descrição: Busca um cliente pelo CPF.
- Parâmetros:
  - cpf: CPF do cliente.
- Retorno: O cliente encontrado (JSON).
GET /cliente/isCadastrado/{id}
- Descrição: Verifica se um cliente está cadastrado pelo ID.
- Parâmetros:
  - id: ID do cliente.
- Retorno: true se o cliente estiver cadastrado, false caso contrário.
PUT /cliente
- Descrição: Atualiza um cliente.
- Corpo (JSON): (mesmo formato do POST, mas com o id do cliente) json { "id": "idDoCliente", "nome": "Novo Nome do Cliente", "cpf": 12345678900, "telefone": 11987654321 }

Documentação OpenAPI

Acesse a documentação da API em: http://localhost:8080/swagger-ui/index.html
A documentação é gerada automaticamente pelo SpringDoc OpenAPI.
A documentação inclui o nome da aplicação, versão, descrição, termos de serviço, licença e contato.

Estrutura do Projeto

src/main/java/br/com/lfrank/config: Classes de configuração.
- MongoConfig: Configura a conexão com o MongoDB.
- OpenAPIConfig: Configura a documentação OpenAPI (Swagger).
- ValidatorConfig: Configura o validador de dados.
src/main/java/br/com/lfrank/domain: Classe de domínio.
- Cliente: Representa a entidade cliente.
src/main/java/br/com/lfrank/repository: Interface do repositório.
- IClienteRepository: Define os mtodos de acesso aos dados do cliente.
src/main/java/br/com/lfrank/resources: Classe do controlador REST.
- ClienteResource: Define os endpoints da API.
src/main/java/br/com/lfrank/usecase: Classes com a logica de negocio.
- Busca: Classe com a logica de busca.
- Cadastro: Classe com a logica de cadastro.
src/main/resources: Arquivos de configuração.
- application.properties: Arquivo de configuração da aplicação.
pom.xml: Arquivo de configuração do maven.

ALGORITHMICALLY RELATED

Similar Open-Source Projects

Selected from shared topics, language and repository description—not editorial ratings.

Gabrieldelacerda /

ExerciciosVariadosJava

★ 2

Olá! Estou de volta após muitas mudanças em minha vida. Comecei um novo trabalho de suporte de TI, entrei no meu último período da faculdade e agora estou aprendendo Java. Seguem alguns dos exercícios iniciais em minha jornada de aprendizado dessa linguagem.

Active repository

JavaNo license

⑂ 0 forks◯ 0 issuesUpdated Feb 20, 2025

View details View on GitHub ↗

Tipimenta /

banco-digital-com-java-e-poo

★ 2

Atráves do conhecimento até o momento adquirido foi realizado um desafio de projeto (conta bancária com java e orientação a objetos), sendo disponibilizado aos seus clientes dois tipos de contas (corrente e poupança), onde são feitas operações de depósito, saque, transferência, pix entre essas contas da própria instituição bancária. Ao término é disponibilizado o extrato das contas com dos dados de cada conta (agencia, número, saldo anterior, último valor tranferido e saldo atual)