Skip to content

Latest commit

 

History

History
198 lines (155 loc) · 5.37 KB

README.md

File metadata and controls

198 lines (155 loc) · 5.37 KB

User API

Esta API fornece endpoints para operações CRUD em usuários.

Ao se cadastrar, será notificado o seu cadastro neste grupo do Telegram, entre para ver a notificação acontecer :) https://t.me/+GathQNdQ8WY1YjIx

Deploy

  • Realizado no Railway utilizando um serviço para o postgres e outro para a própria aplicação
  • CI/CD realizado pelo próprio github

Deploy: https://user-api-production-6d74.up.railway.app/ OBS: Por favor, faça testes com moderação, é uma API para fins de estudos e utiliza o plano gratuito.

Diagrama de Classes

classDiagram
    class Address {
        String cep
        String bairro
        String cidade
        String estado
        String logradouro
    }

    class User {
        String id
        String username
        String name
        String apresentation
        Address address
    }

    Address <|-- User : address
Loading

Serviços e Repositórios

classDiagram
    class AddressService {
        +Address getAddress(String cep)
        +void saveAddress(Address address)
    }

    class UserService {
        +ResponseUserDTO saveNewUser(RequestUserDTO data)
        +ResponseAllUsersDTO findAllUsers()
        +ResponseUserDTO findUserByUsername(String username)
        +void deleteUserByUsername(String username)
        +ResponseUserDTO updateUserByUserName(String username, RequestUserDTO data)
    }

    AddressService ..> AddressRepository : uses
    AddressService ..> CEPClient : uses

    UserService ..> UserRepository : uses
    UserService ..> AddressService : uses

    class AddressRepository
    class CEPClient
    class UserRepository
Loading

DTOs

   classDiagram
    %% DTO Classes
    class ResponseAddressDTO {
        +String cep()
        +String bairro()
        +String cidade()
        +String estado()
        +String logradouro()
    }

    class RequestUserDTO {
        +String username()
        +String name()    
        +String apresentation
        +String cep()
    }

    class ResponseUserDTO {
        +ResponseUserDTO(String name, String email, Address address)
        +String name
        +String username
        +String apresentation
        +String cidade
        +String estado

    }

    class ResponseAllUsersDTO {
        +ResponseAllUsersDTO(List<ResponseUserDTO> users)
        +List<ResponseUserDTO> users
    }

    %% Relationships
    ResponseAddressDTO <|-- Address
    RequestUserDTO <|-- User
    ResponseUserDTO <|-- User
    ResponseAllUsersDTO ..> ResponseUserDTO : contains
Loading

Exceptions

classDiagram
    %% Exceptions
    class AddressNotFoundException
    class UsernameAlreadyExistsException
    class UserListIsEmptyException
    class UserNotFoundException

    %% Relationships with Services
    AddressService ..> AddressNotFoundException : throws
    UserService ..> UsernameAlreadyExistsException : throws
    UserService ..> UserListIsEmptyException : throws
    UserService ..> UserNotFoundException : throws
Loading

APIs Externas

Endpoints

1. Listar todos os usuários (/user)

Descrição: Retorna uma lista de todos os usuários.

  • Método HTTP: GET
  • Status: 200 OK
  • Body: ResponseAllUsersDTO - Um objeto contendo uma lista de todos os usuários.

2. Obter usuário por nome de usuário(/user/{username})

Descrição: Retorna um usuário específico com base no nome de usuário fornecido.

  • Método HTTP: GET
  • Parâmetros de URL:
  • Status: 200 OK
  • Body: ResponseUserDTO - Um objeto contendo os detalhes do usuário solicitado.

3. Criar um novo usuário (/user)

Descrição: Cria um novo usuário com base nos dados fornecidos.

  • Método HTTP: POST -Status: 201 Created
  • Body: ResponseUserDTO - Um objeto contendo os detalhes do usuário criado.

Exemplo de JSON:

{
"username": "usuário",
"name": "usuário 1",
"apresentation" : "eu sou o usuário",
"cep": "73105904" 
}

4. Excluir usuário por nome de usuário (/user/{username})

Descrição: Exclui um usuário com base no nome de usuário fornecido.

  • Método HTTP: DELETE
  • Parâmetros de URL: username - Nome de usuário do usuário que você deseja excluir.
  • Status: 200 OK
  • Body: HttpStatus.OK

5. Atualizar um usuário(/user/{username})

Descrição: Atualiza os dados de um usuário com base no nome de usuário fornecido.

  • Método HTTP: PUT
  • Parâmetros de URL:username - Nome de usuário do usuário que você deseja atualizar.
  • RequestUserDTO - Um objeto contendo os novos dados do usuário.
  • Status: 200 OK
  • Body: ResponseUserDTO - Um objeto contendo os detalhes atualizados do usuário.

Exemplo de JSON:

{
  "username": "usuário",
  "name": "usuário 1",
  "apresentation" : "eu sou o usuário",
  "cep": "73105904"
  }

Tecnologias Utilizadas

  • Java 17: Linguagem de programação
  • Spring Boot 3: Aplicação do Spring Framework
  • Postgres 16: Banco de dados relacional
  • Spring JPA: Abstração de persistência de dados para Java, que simplifica a interação com bancos de dados.
  • Swagger OpenAPI: Ferramenta para documentar e testar a API.
  • FlyWay: Ferramenta para migração de banco de dados, gerenciando mudanças no esquema.
  • Lombok: Biblioteca para simplificar a escrita de código Java, eliminando código boilerplate.
  • FeignClient: Cliente HTTP declarativo para chamar outras APIs.