├── .gitignore ├── APIs ├── BANCO.md ├── ENDERECO.md ├── IMOBILIARIA.md ├── LOTERIA.md ├── VACINA.md └── VEICULOS.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── DESAFIOS.md ├── LICENSE ├── README.md ├── pom.xml └── src ├── main ├── java │ └── br │ │ └── com │ │ └── training │ │ ├── TrainingApiApplication.java │ │ ├── controller │ │ └── UserController.java │ │ ├── model │ │ └── User.java │ │ └── repository │ │ └── UserRepository.java └── resources │ └── application.properties └── test └── java └── br └── com └── training └── TrainingApiApplicationTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | *.java.hsp 2 | *.sonarj 3 | *.sw* 4 | .DS_Store 5 | .settings 6 | .springBeans 7 | bin 8 | build.sh 9 | integration-repo 10 | ivy-cache 11 | jxl.log 12 | jmx.log 13 | derby.log 14 | spring-test/test-output/ 15 | .gradle 16 | argfile* 17 | pom.xml 18 | activemq-data/ 19 | 20 | classes/ 21 | /build 22 | buildSrc/build 23 | /spring-*/build 24 | /spring-core/kotlin-coroutines/build 25 | /framework-bom/build 26 | /integration-tests/build 27 | /src/asciidoc/build 28 | target/ 29 | 30 | # Eclipse artifacts, including WTP generated manifests 31 | .classpath 32 | .project 33 | spring-*/src/main/java/META-INF/MANIFEST.MF 34 | 35 | # IDEA artifacts and output dirs 36 | *.iml 37 | *.ipr 38 | *.iws 39 | .idea 40 | out 41 | test-output 42 | atlassian-ide-plugin.xml 43 | .gradletasknamecache 44 | 45 | # VS Code 46 | .vscode/ -------------------------------------------------------------------------------- /APIs/BANCO.md: -------------------------------------------------------------------------------- 1 | # API de Banco 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md). 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Banco 10 | 11 | ### Integrações 12 | 13 | Integrações entre APIs são frequentes, e existem varias maneiras de fazer isso, usando `Rest Template` ou `FeignClient` por exemplo. 14 | 15 | Seguem algumas referências a respeito: 16 | 17 | - [Feign](https://domineospring.wordpress.com/2017/06/02/feign-uma-forma-simples-para-consumir-servicos/) 18 | - [Rest Template](https://www.ti-enxame.com/pt/java/como-post-forma-dados-com-spring-resttemplate/825640550/) 19 | - [Diferenças Feign e Rest Template](https://www.ti-enxame.com/pt/spring-boot/quais-sao-vantagens-e-desvantagens-do-uso-de-simulacao-em-relacao-ao-resttemplate/835724322/) 20 | 21 | #### Tarefa: Camada de Contas 22 | 23 | - Implementar um segundo controller `AccountController` com um CRUD para cadastrar, buscar, atualizar e remover contas de usuários cadastrados num banco, usando o [serviço da BrasilAPI](https://brasilapi.com.br/docs#tag/BANKS/paths/~1banks~1v1/get) para buscar os dados de um banco baseado no seu `código (code)`. 24 | 25 | *Essa implementação vai envolver não apenas um Controller, mas um AccountService, Account DAO e DTOS, assim que AccountRepository.* 26 | 27 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Account`. 28 | 29 | #### Regras de negócios (Contas) 30 | 31 | - A entidade de `Account` deve ser composta dos seguintes campos: 32 | 33 | Campo | Obrigótorio | Observação 34 | ------------ | ------------ | ------------- 35 | **id** | SIM | Identificador (único) da conta 36 | **bank** | SIM | ex: `Banco do Brasil S.A.` (`fullname` da resposta da [Bank API](https://brasilapi.com.br/docs#tag/BANKS/paths/~1banks~1v1/get)) 37 | **balance** | SIM | ex: `100.00` (saldo da conta) 38 | **createdAt** | SIM | ex: `2021/19/06` (data de criação da conta) 39 | 40 | - Não deve ser permitido criar uma conta para um usuário não cadastrado. 41 | - O usuário só pode ter uma conta. 42 | - A relação entre a entidade de usuário e a entidade de conta deve ser feita pelo **CPF do usuário**. Seguem algumas referências abaixo: 43 | - [Chaves primaria e estrangeira SQL](https://www.devmedia.com.br/sql-aprenda-a-utilizar-a-chave-primaria-e-a-chave-estrangeira/37636) 44 | 45 | * * * 46 | 47 | #### Tarefa: Camada de Operações 48 | 49 | - Implementar um terceiro controller `OperationController` com um conjunto de endpoints permitindo: 50 | - depositar dinheiro numa conta 51 | - saquar dinheiro de uma conta 52 | - transferir dinheiro para uma outra conta 53 | - consultar o histórico de operações da conta (listar as operações) 54 | 55 | *Essa implementação vai envolver não apenas um Controller, mas um OperationService, Operation DAO e DTOS, assim que OperationRepository.* 56 | 57 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Operation`. 58 | 59 | #### Regras de negócios (Operações) 60 | 61 | - A entidade de `Operation` deve ser composta dos seguintes campos: 62 | 63 | Campo | Obrigótorio | Observação 64 | ------------ | ------------ | ------------- 65 | **id** | SIM | Identificador (único) da operação 66 | **operationType** | SIM | ex: `DEPOSIT` ou `CASHOUT` ou `TRANSFER` 67 | **value** | SIM | ex: `100.00` 68 | **date** | SIM | ex: `2021/19/06` (data em qual a operação foi realizada) 69 | **originAccountId** | SIM | Identificador (único) da conta de origem 70 | **destinationAccountId** | YES | Identificador (único) da conta de destino 71 | 72 | - O saldo da conta não pode ficar negativo após uma operação. 73 | - Não deve ser possível fazer saques ou transferências quando o saldo da conta é insuficiente. 74 | - As contas envolvidas em qualquer operação devem ser válidas. 75 | - O ID da conta de destino de uma transferência deve ser incluído na resposta do pedido de transferência. 76 | - Um extrato deve retornar todos os movimentos da conta (transferências, depósitos e saques). 77 | - Não deve ser possível fazer uma transferência para você (a conta de origem não pode ser igual à conta de destino **quando for uma transferência** (pode ser para depósitos ou saques)). 78 | - Apagar um usuário deve apagar sua conta, mas não o seu histórico de operações. 79 | -------------------------------------------------------------------------------- /APIs/ENDERECO.md: -------------------------------------------------------------------------------- 1 | # API de Endereços 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md). 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Endereços 10 | 11 | ### Integrações 12 | 13 | Integrações entre APIs são frequentes, e existem varias maneiras de fazer isso, usando `Rest Template` ou `FeignClient` por exemplo. 14 | 15 | Seguem algumas referências a respeito: 16 | 17 | - [Feign](https://domineospring.wordpress.com/2017/06/02/feign-uma-forma-simples-para-consumir-servicos/) 18 | - [Rest Template](https://www.ti-enxame.com/pt/java/como-post-forma-dados-com-spring-resttemplate/825640550/) 19 | - [Diferenças Feign e Rest Template](https://www.ti-enxame.com/pt/spring-boot/quais-sao-vantagens-e-desvantagens-do-uso-de-simulacao-em-relacao-ao-resttemplate/835724322/) 20 | 21 | #### Tarefa: Camada de Endereços 22 | 23 | - Implementar um segundo controller `AddressController` com um CRUD para cadastrar, buscar, atualizar e remover endereços de usuários cadastrados, usando o [serviço da VIACEP](https://viacep.com.br/) para buscar os dados de um endereço baseado no seu **CEP**. 24 | 25 | *Essa implementação vai envolver não apenas um Controller, mas um AddressService, Address DAO e DTOS, assim que AddressRepository.* 26 | 27 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Address`. 28 | 29 | #### Regras de negócios 30 | 31 | - A entidade de `Address` deve ser composta dos seguintes campos: 32 | 33 | Campo | Obrigótorio | Observação 34 | ------------ | ------------ | ------------- 35 | **id** | SIM | Identificador (único) do endereço 36 | **cep** | SIM | ex: `00000-111` 37 | **logradouro** | SIM | ex: `Rua João` 38 | **numero** | SIM | ex: `12` 39 | **complemento** | NÃO | ex: `apartamento 101` 40 | **bairro** | SIM | ex: `Santa Maria` 41 | **cidade** | SIM | ex: `São Paulo` 42 | **estado** | SIM | ex: `SP` 43 | 44 | - Não deve ser permitido cadastrar um endereço para um usuário não cadastrado. 45 | - Um usuário pode ter mais de um endereço. 46 | - A relação entre a entidade de usuário e a entidade de endereço deve ser feita pelo **ID do usuário**. Seguem algumas referências abaixo: 47 | - [Chaves primaria e estrangeira SQL](https://www.devmedia.com.br/sql-aprenda-a-utilizar-a-chave-primaria-e-a-chave-estrangeira/37636) 48 | - [Relacionamento @OneToMany e @ManyToOne](https://imasters.com.br/banco-de-dados/como-criar-relacionamento-onetomany-com-hibernate) 49 | - Apagar um usuário deve apagar seus endereços também. 50 | -------------------------------------------------------------------------------- /APIs/IMOBILIARIA.md: -------------------------------------------------------------------------------- 1 | # API de Imobiliária 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md) assim que ter feito o exercício do nível 2: [API de Endereços](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/ENDERECO.md) 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Imobiliária 10 | 11 | #### Tarefa: Camada de Imobiliária 12 | 13 | - Implementar um segundo controller `PropertyController` com um CRUD para cadastrar, buscar, atualizar e remover imóveis. 14 | 15 | *Essa implementação vai envolver não apenas um Controller, mas um PropertyService, Property DAO e DTOS, assim que PropertyRepository.* 16 | 17 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Property`. 18 | 19 | #### Regras de negócios (Imobiliária) 20 | 21 | - A entidade de `Property` deve ser composta dos seguintes campos: 22 | 23 | Campo | Obrigótorio | Observação 24 | ------------ | ------------ | ------------- 25 | **id** | SIM | Identificador (único) do imóvel 26 | **addressId** | SIM | Identificador (único) do endereço do imóvel (cf, classe `Address` criada no desafio Nível 2) 27 | **aluguel** | NO | ex: `1500.00` (valor do aluguel do imóvel) 28 | **venda** | NO | ex: `700000.00` (valor de venda do imóvel) 29 | **status** | NO | ex: `VENDENDO` (estado em qual o imóvel se encontra: `VENDENDO` - `ALUGANDO` - `VENDIDO` - `ALUGADO`) 30 | **active** | NO | ex: `true` (se o imóvel está no mercado ou não) 31 | **constructedAt** | NO | ex: `2021/18/06` (data de construção do imóvel) 32 | **createdAt** | SIM | ex: `2021/19/06` (data de cadastro do imóvel) 33 | **updatedAt** | NO | ex: `2021/20/06` (data de atualização do imóvel) 34 | 35 | - Não deve ser possível ter 2 imóveis com o mesmo endereço. 36 | - Um imóvel precisa ter um valor de aluguel ou de venda (não pode estar com os 2 campos vazios). 37 | - Ao cadastrar um imóvel, é preciso informar seu `status` (inicialmente, só pode ser `VENDENDO` ou `ALUGANDO`) com o campo `active` ativado (_true_). 38 | - Ao remover um imóvel, o campo `active` deve ser desativado (`false`). Não deve apagar os dados do banco. 39 | - Não é possível fazer uma busca de um imóvel desativado (`active` = `false`). 40 | - Além do CRUD, é preciso desenvolver um serviço para buscar todos os imóveis **ativos** de acordo com filtros: `CEP`, `VENDENDO`, `ALUGANDO` 41 | 42 | * * * 43 | 44 | #### Tarefa: Contrato 45 | 46 | - Implementar um terceiro controller `ContractController` com um conjunto de endpoints permitindo: 47 | - criar um contrato associando um imóvel a um usuário. 48 | - buscar um contrato (pelo id do imóvel) 49 | - buscar um contrato (pelo CPF de um usuário) 50 | - atualizar um contrato 51 | - encerrar um contrato 52 | 53 | *Essa implementação vai envolver não apenas um Controller, mas um ContractService, Contract DAO e DTOS, assim que ContractRepository.* 54 | 55 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Contract`. 56 | 57 | #### Regras de negócios (Contrato) 58 | 59 | - A entidade de `Contract` deve ser composta dos seguintes campos: 60 | 61 | Campo | Obrigótorio | Observação 62 | ------------ | ------------ | ------------- 63 | **id** | SIM | Identificador (único) do contrato 64 | **userId** | SIM | Identificador (único) do usuário 65 | **propertyId** | YES | Identificador (único) do imóvel 66 | **valor** | YES | ex: `1500.00` (valor do contrato) 67 | **aluguel** | NO | ex: `true` (se é um contrato de aluguel ou não) 68 | **venda** | NO | ex: `true` (se é um contrato de venda ou não) 69 | **active** | NO | ex: `true` (se o contrato ainda está válido ou não) 70 | **createdAt** | SIM | ex: `2021/19/06` (data da criação do contrato) 71 | **updatedAt** | SIM | ex: `2021/19/06` (data da atualização do contrato) 72 | 73 | - Não pode ter 2 contratos ativos entre um imóvel e um usuário. 74 | - Um contrato não pode ser de aluguel e de venda ao mesmo tempo. 75 | - O valor do contrato é o mesmo que o valor associado ao imóvel caso seja de aluguel ou de venda. 76 | - Ao cadastrar um contrato, seu campo `active` deve ser ativado (`true`) e o imóvel associado deve ter seu estado atualizado (para `ALUGADO` ou `VENDIDO`). 77 | - Não pode encerrar um contrato de venda. 78 | - Ao encerrar um contrato de alguel, o campo `active` deve ser desativado (`false`) - _Não deve apagar os dados do banco_ - e caso era um contrato de aluguel, o imóvel associado deve ter seu estado atualizado para `ALUGANDO`. -------------------------------------------------------------------------------- /APIs/LOTERIA.md: -------------------------------------------------------------------------------- 1 | # API de Loteria 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md). 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Loteria 10 | 11 | #### Tarefa: Camada de Apostas 12 | 13 | - Implementar um segundo controller `BetController` com um CRUD para cadastrar, buscar e remover apostas de usuários cadastrados. 14 | 15 | *Essa implementação vai envolver não apenas um Controller, mas um BetService, Bet DAO e DTOS, assim que BetRepository.* 16 | 17 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Bet`. 18 | 19 | #### Regras de negócios (Apostas) 20 | 21 | - A entidade de `Bet` deve ser composta dos seguintes campos: 22 | 23 | Campo | Obrigótorio | Observação 24 | ------------ | ------------ | ------------- 25 | **id** | SIM | Identificador (único) da aposta 26 | **numbers** | SIM | ex: `[ 1, 2, 3, 4]` (lista de números da aposta) 27 | **createdAt** | SIM | ex: `2021/19/06` (data de criação da aposta) 28 | 29 | - Num primeiro momento, você pode definir qualquer regra para a geração de aposta (`X` números para cada aposta, onde os números podem variar de 1 até `Y`) 30 | - Não deve ser permitido criar uma aposta para um usuário não cadastrado. 31 | - Uma aposta não pode conter números repetidos. 32 | - O usuário pode ter mais do que uma aposta, sendo que 2 apostas de um mesmo usuário não podem ser iguais. 33 | - A relação entre a entidade de usuário e a entidade de aposta deve ser feita pelo **CPF do usuário**. Seguem algumas referências abaixo: 34 | - [Chaves primaria e estrangeira SQL](https://www.devmedia.com.br/sql-aprenda-a-utilizar-a-chave-primaria-e-a-chave-estrangeira/37636) 35 | 36 | ### Customizar a API 37 | 38 | Na tarefa anterior, foi permitido seguir com qualquer regra para geração de aposta (`X` números para cada aposta, onde os números podem variar de 1 até `Y`). 39 | 40 | O objetivo dessa tarefa agora é tornar aquilo customizável, sem precisar alterar o código para gerar apostas com regras diferentes. 41 | 42 | Para isso, sugerimos criar mais uma entidade, onde armazenaremos as configurações da nossa API para gerar apostas. 43 | 44 | #### Tarefa: Camada de configurações 45 | 46 | - A entidade de `Configuration` deve ser composta dos seguintes campos: 47 | 48 | Campo | Obrigótorio | Observação 49 | ------------ | ------------ | ------------- 50 | **key** | SIM | ex: `MAX_NUMBER` (chave **única** para se referir a configuração) 51 | **value** | SIM | ex: `100` (valor associado a chave) 52 | **createdAt** | SIM | ex: `2021/19/06` (data de criação da configuração) 53 | **updatedAt** | NO | ex: `2021/20/06` (data de atualização da configuração) 54 | 55 | - Implemente um terceiro controller `ConfigurationController` com um CRUD para cadastrar, buscar, atualizar e remover configurações da API. 56 | 57 | *Essa implementação vai envolver não apenas um Controller, mas um ConfigurationService, Configuration DAO e DTOS, assim que ConfigurationRepository.* 58 | 59 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Configuration`. 60 | 61 | - Atualizar a API existente para gerar as apostas buscando as configurações da API. O objetivo é de buscar na tabela de configurações 2 valores antes de gerar a aposta: 62 | - A quantidade de números contida em cada aposta (O `X` acima). 63 | - O valor máximo desses números (O `Y` acima). 64 | 65 | #### Bônus 66 | 67 | - Use `Headers` (cabeçalhos) para distinguir requisições gerando apostas usando configurações diferentes da tabela. Exemplo: 68 | - Configuração 1 = aposta com 3 números de 1 até 50 69 | - Configuração 2 = aposta com 5 números de 1 até 100 70 | 71 | Para isso, mude apenas as classes de `BetController` e `BetService` (assim que os testes unitarios relacionados). 72 | 73 | Seguem algumas referências a respeito: 74 | 75 | - [HTTP Headers](https://www.devmedia.com.br/http-headers/41219) 76 | - [Como adicionar cabeçalhos na chamado RESTful](https://www.ti-enxame.com/pt/java/como-adicionar-cabecalhos-na-chamada-restful-usando-api-do-cliente-jersey/1040425012/) 77 | - [Artigo Web Services em REST usando Headers](http://www.ricardoluis.com/wp-content/uploads/2015/08/Artigo-WebServices-em-REST.pdf) 78 | - [Como obter acesso às informações do cabeçalho HTTP no controlador Spring MVC REST?](https://qastack.com.br/programming/19556039/how-to-get-access-to-http-header-information-in-spring-mvc-rest-controller) 79 | - [Como definir um cabeçalho "Accept:" na solicitação Spring RestTemplate?](https://qastack.com.br/programming/19238715/how-to-set-an-accept-header-on-spring-resttemplate-request) 80 | -------------------------------------------------------------------------------- /APIs/VACINA.md: -------------------------------------------------------------------------------- 1 | # API de Vacinas 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md). 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Vacinas 10 | 11 | ### Integrações 12 | 13 | Integrações entre APIs são frequentes, e existem varias maneiras de fazer isso, usando `Rest Template` ou `FeignClient` por exemplo. 14 | 15 | Seguem algumas referências a respeito: 16 | 17 | - [Feign](https://domineospring.wordpress.com/2017/06/02/feign-uma-forma-simples-para-consumir-servicos/) 18 | - [Rest Template](https://www.ti-enxame.com/pt/java/como-post-forma-dados-com-spring-resttemplate/825640550/) 19 | - [Diferenças Feign e Rest Template](https://www.ti-enxame.com/pt/spring-boot/quais-sao-vantagens-e-desvantagens-do-uso-de-simulacao-em-relacao-ao-resttemplate/835724322/) 20 | 21 | #### Tarefa: Camada de Vacinas 22 | 23 | - Implementar um segundo controller `VaccineController` com um CRUD para cadastrar, buscar, atualizar e remover vacinas, usando o [serviço da MediaWiki](https://documenter.getpostman.com/view/4692440/RWEmKHEN#1279e688-9a11-424b-bd15-be1ca9e4cf7f) para buscar a descrição de uma doença baseada no seu **nome**. 24 | 25 | *Essa implementação vai envolver não apenas um Controller, mas um VaccineService, Vaccine DAO e DTOS, assim que VaccineRepository.* 26 | 27 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Vaccine`. 28 | 29 | #### Regras de negócios (Vacinas) 30 | 31 | - A entidade de `Vaccine` deve ser composta dos seguintes campos: 32 | 33 | Campo | Obrigótorio | Observação 34 | ------------ | ------------ | ------------- 35 | **id** | SIM | Identificador (único) da vacina 36 | **name** | SIM | ex: `Pfizer` (nome da vacina) 37 | **disease** | SIM | ex: `Covid-19` (nome da doença que a vacina cura) 38 | **diseaseDescription** | NO | ex: `Coronavirus disease (COVID-19) is an infectious disease caused by a newly discovered coronavirus.` (descrição da doença) 39 | **minimumAge** | SIM | ex: `5` (idade mínima *em anos* para usuário receber a vacina) 40 | **dosesAmount** | SIM | ex: `2` (quantidade de doses necessárias da vacina) 41 | **createdAt** | SIM | ex: `2021/19/06` (data de criação da vacina) 42 | **updatedAt** | NO | ex: `2021/20/06` (data de atualização da vacina) 43 | 44 | - Não deve ser possível ter 2 vacinas com o mesmo nome. 45 | - Pode ter várias vacinas para a mesma doença. 46 | - A descrição da doença que a vacina cura deve ser preenchida se retornada pelo serviço da [MediaWiki](https://documenter.getpostman.com/view/4692440/RWEmKHEN#1279e688-9a11-424b-bd15-be1ca9e4cf7f), senão deve ser salvo com o valor `N/A`. 47 | 48 | * * * 49 | 50 | #### Tarefa: Aplicação de Vacinas 51 | 52 | - Implementar um terceiro controller `VaccineApplicationController` com um conjunto de endpoints permitindo: 53 | - aplicar uma vacina a um usuário. 54 | - listar todas as vacinas que foram aplicadas para um usuário. 55 | 56 | *Essa implementação vai envolver não apenas um Controller, mas um VaccineApplicationService, VaccineApplication DAO e DTOS, assim que VaccineApplicationRepository.* 57 | 58 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `VaccineApplication`. 59 | 60 | #### Regras de negócios (Aplicação de Vacinas) 61 | 62 | - A entidade de `VaccineApplication` deve ser composta dos seguintes campos: 63 | 64 | Campo | Obrigótorio | Observação 65 | ------------ | ------------ | ------------- 66 | **id** | SIM | Identificador (único) da aplicação da dose da vacina 67 | **date** | SIM | ex: `2021/19/06` (data em qual a dose da vacina foi aplicada ao usuário) 68 | **userId** | SIM | Identificador (único) do usuário 69 | **vaccineId** | YES | Identificador (único) da vacina 70 | 71 | - Não deve ser permitido aplicar uma vacina não cadastrada para um usuário. 72 | - Não deve ser permitido aplicar uma vacina para um usuário não cadastrado. 73 | - Um mesmo usuário não pode receber mais aplicações da mesma vacina do que a quantidade de doses informada na entidade da vacina. 74 | - Um usuário não pode receber 2 aplicações da mesma vacina **dentro de 30 dias**. 75 | - A relação entre a entidade de aplicação de vacinas e as entidades de usuário e vacina deve ser feita pelo **ID do usuário** e o **ID da vacina**. Seguem algumas referências abaixo: 76 | - [Chaves primaria e estrangeira SQL](https://www.devmedia.com.br/sql-aprenda-a-utilizar-a-chave-primaria-e-a-chave-estrangeira/37636) 77 | - [Relacionamento @OneToMany e @ManyToOne](https://imasters.com.br/banco-de-dados/como-criar-relacionamento-onetomany-com-hibernate) 78 | - Apagar um usuário deve apagar seus endereços também. 79 | -------------------------------------------------------------------------------- /APIs/VEICULOS.md: -------------------------------------------------------------------------------- 1 | # API de Veículos 2 | 3 | Para seguir com as atividades desse arquivo, é preciso ter realizado previamente as 4 primeiras partes do arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md). 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | * * * 8 | 9 | ## Vehicle 10 | 11 | ### Integrações 12 | 13 | Integrações entre APIs são frequentes, e existem varias maneiras de fazer isso, usando `Rest Template` ou `FeignClient` por exemplo. 14 | 15 | Seguem algumas referências a respeito: 16 | 17 | - [Feign](https://domineospring.wordpress.com/2017/06/02/feign-uma-forma-simples-para-consumir-servicos/) 18 | - [Rest Template](https://www.ti-enxame.com/pt/java/como-post-forma-dados-com-spring-resttemplate/825640550/) 19 | - [Diferenças Feign e Rest Template](https://www.ti-enxame.com/pt/spring-boot/quais-sao-vantagens-e-desvantagens-do-uso-de-simulacao-em-relacao-ao-resttemplate/835724322/) 20 | 21 | #### Tarefa: Camada de Vehicle 22 | 23 | - Implementar um segundo controller `VehicleController` com um CRUD para cadastrar, buscar, atualizar e remover veículos, usando o [serviço da FIPE](https://deividfortuna.github.io/fipe) para buscar os dados de um veículo. 24 | 25 | *Essa implementação vai envolver não apenas um Controller, mas um VehicleService, Vehicle DAO e DTOS, assim que VehicleRepository.* 26 | 27 | - Implementar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Vehicle`. 28 | 29 | #### Regras de negócios (Veículos) 30 | 31 | - A entidade de `Vehicle` deve ser composta dos seguintes campos: 32 | 33 | Campo | Obrigótorio | Observação 34 | ------------ | ------------ | ------------- 35 | **id** | SIM | Identificador (único) do veículo 36 | **brand** | SIM | ex: `VW - VolksWagen` (`marca` do veículo) 37 | **model** | SIM | ex: `AMAROK High.CD 2.0 16V TDI 4x4 Dies. Aut` (modelo do veículo) 38 | **year** | SIM | ex: `2014` (ano no veículo) 39 | **price** | SIM | ex: `R$ 109.888,00` (valor do veículo de acordo com a API da FIPE) 40 | **createdAt** | SIM | ex: `2021/19/06` (data de adição do veículo ao banco de dados) 41 | 42 | - Os dados informados devem ser confirmados na API da FIPE (para comprovar que são válidos) 43 | - Não deve ser permitido cadastrar 2 vezes o mesmo veículo. 44 | - O preço do veículo deve ser calculado de acordo com os outros dados obrigatórios na FIPE. 45 | 46 | #### Bônus 47 | 48 | No endpoint que irá listar os veículos, devemos considerar algumas configurações a serem exibidas para o usuário final (no DTO de Response). 49 | Para isso, vamos criar dois novos atributos no objeto do carro, sendo eles: 50 | 51 | 1. `Dia do rodízio` do carro, baseado no último número do ano do veículo, considerando as condicionais: 52 | - Final 0-1: segunda-feira 53 | - Final 2-3: terça-feira 54 | - Final 4-5: quarta-feira 55 | - Final 6-7: quinta-feira 56 | - Final 8-9: sexta-feira 57 | 58 | 2. Também devemos criar um atributo de `rodízio` ativo, onde a data atual do sistema será comparada com as condicionais anteriores, onde, quando for o dia ativo do rodizio retornar true, caso contrario, false. 59 | 60 | Campo | Obrigótorio | Observação 61 | ------------ | ------------ | ------------- 62 | **rotationDay** | SIM | ex: `segunda-feira` (dia que o carro não pode andar na rua) 63 | **rotation** | SIM | ex: `true` (se é (ou não) o dia do carro não poder andar na rua) 64 | 65 | * * * 66 | 67 | #### Tarefa: Camada de Ownership 68 | 69 | - Atualizar o controller `OwnershipController` com um CRUD para cadastrar, buscar, atualizar e remover `veículos de usuários`, usando o [serviço da FIPE](https://deividfortuna.github.io/fipe) através da classe de Service criada na tarefa anterior para validar os dados de um veículo. 70 | 71 | *Essa implementação vai envolver não apenas um Controller, mas também OwnershipService, Ownership DAO e DTOS, assim que OwnershipRepository.* 72 | 73 | - Atualizar os testes unitários das camadas de `Service` e `Controller` relacionados a entidade de `Ownership`. 74 | 75 | #### Regras de negócios (Ownership) 76 | 77 | - A entidade de `Ownership` deve ser composta dos seguintes campos: 78 | 79 | Campo | Obrigótorio | Observação 80 | ------------ | ------------ | ------------- 81 | **id** | SIM | Identificador (único) da relação de propriedade entre o veículo e um usuário 82 | **id_vehicle** | SIM | Identificador (único) do veículo 83 | **cpf_user** | SIM | ex: `111.222.333-44` (`cpf` do dono do veículo (usuário)) 84 | **createdAt** | SIM | ex: `2021/19/06` (data de adição da relação no banco de dados) 85 | **updatedAt** | NÃO | ex: `2021/20/06` (data de atualização da relação no banco de dados) 86 | 87 | - Não deve ser permitido associar um veículo a um usuário não cadastrado. 88 | - Deve ser permitido associar um usuário a um veículo não cadastrado, neste caso, o veículo devo ser cadastrado na hora (caso os dados sejam validados pela FIPE). 89 | - Um usuário pode cadastrar quantos veículos quiser. 90 | - Um veículo não pode pertencer a 2 usuários ao mesmo tempo. 91 | - A relação de propriedade entre a entidade de usuário e a entidade de veículos deve ser feita pelo **CPF do usuário**. Seguem algumas referências abaixo: 92 | - [Chaves primaria e estrangeira SQL](https://www.devmedia.com.br/sql-aprenda-a-utilizar-a-chave-primaria-e-a-chave-estrangeira/37636) 93 | 94 | No Controller `UserController` 95 | - Quando retornar os dados de um usuário, será necessário retornar todos os dados dos seus veículos cadastrados (inclusive `rotation` e `rotationDay`). Retornar uma lista vazia caso não tenha nenhum veículo cadastrado. 96 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | guillaume.falourd@com.br. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribuir 2 | 3 | Valorizamos suas contribuições e queremos torná-lo o mais fácil quanto possível para trabalhar neste repositório. 4 | Uma das primeiras coisas a decidir é em qual `branch` basear seu trabalho. 5 | Se você ficar confuso, basta perguntar e nós iremos ajuda. 6 | Se um revisor perceber que você baseou seu trabalho na `branch` errada, iremos informá-lo para que você possa rebase-lo. 7 | 8 | ## Novas funcionalidades para o projeto 9 | 10 | **Sempre basea seu trabalha na branch `main`, seguindo a guia abaixo :** 11 | 12 | ![git-branchs](https://user-images.githubusercontent.com/22433243/122411943-8d07bc00-cf5b-11eb-82d1-d287bb8c93ce.png) 13 | 14 | **Exemplos : `feature/name` or `fix/name`** 15 | 16 | ## Guias 17 | 18 | - Fique a vontade para contribuir com novos conteúdos ou desafios. 19 | 20 | - Os novos textos (desafios) precisam ser escritos em português. 21 | 22 | - Os novos conteúdos adicionados (links) devem ser em português. 23 | -------------------------------------------------------------------------------- /DESAFIOS.md: -------------------------------------------------------------------------------- 1 | # DESAFIOS 2 | 3 | Esse arquivos contem sugestões de desafios para melhorar a API contida nesse repositório. 4 | 5 | **Após cada parte deste desafio, como entrega da atividade, enviar o link do repositório criado (no LinkedIn ou por email).** 6 | 7 | ## O que melhorar nesta API? 8 | 9 | Antes de você começar a melhorar essa API REST, recomendo ler os artigos abaixo para alinhar o conhecimento sobre Java, REST, Spring, SOLID e o padrão MVC (Model View Controller): 10 | 11 | - [Patterns Java Orientação a Objetos](https://www.devmedia.com.br/diferenca-entre-os-patterns-po-pojo-bo-dto-e-vo/28162) 12 | - [Programação Orientada a Objetos (POO)](https://www.alura.com.br/artigos/poo-programacao-orientada-a-objetos) 13 | - [Polimorfismo (Java)](https://www.devmedia.com.br/uso-de-polimorfismo-em-java/26140#:~:text=Polimorfismo%20significa%20%22muitas%20formas%22%2C,diferentes%20ao%20receber%20uma%20mensagem) 14 | - [Herança + Interfaces (Java)](https://www.alura.com.br/conteudo/java-heranca-interfaces-polimorfismo?gclid=Cj0KCQjws-OEBhCkARIsAPhOkIYTKKe6f3i2zrECbjlY-KyQUQfT1E1mLSWcznn0gFyP7HKI0tKPfVwaAsVCEALw_wcB) 15 | - [REST](https://www.devmedia.com.br/rest-tutorial/28912) 16 | - [SPRING-BOOT, como começar?](https://www.zup.com.br/blog/spring-boot) 17 | - [SOLID](https://www.eduardopires.net.br/2013/04/orientacao-a-objeto-solid/#:~:text=SOLID%20%C3%A9%20um%20acr%C3%B4nimo%20dos,poderiam%20se%20encaixar%20nesta%20palavra) 18 | - [SOLID para Devs de alta performance](https://www.zup.com.br/blog/solid-devs-de-alta-performance) 19 | - [MVC](https://www.devmedia.com.br/padrao-mvc-java-magazine/21995#2) 20 | - [Introdução ao Padrão MVC](https://www.devmedia.com.br/introducao-ao-padrao-mvc/29308) 21 | - [Evolução do MVC para REST](https://imasters.com.br/devsecops/a-evolucao-do-mvc-para-rest#:~:text=Em%20outras%20palavras%2C%20REST%20garante,sem%20acoplamento%20entre%20as%20partes.&text=Isso%20garante%20que%20podemos%20construir,quem%20vai%20usar%20estes%20dados) 22 | - [Conceitos Spring Data Jpa](https://ulyssesuchoa.medium.com/spring-data-jpa-445dbfbb70f0) 23 | 24 | * * * 25 | 26 | ## 1️⃣ Primeira parte 27 | 28 | Na primeira parte desse desafio, o objetivo vai ser de atualizar a estrutura do projeto, e completar o CRUD (Create, Read, Update e Delete) do Controller. 29 | 30 | ### Versionando seu código 31 | 32 | #### Tarefa 🔀 33 | 34 | - O versionamento do nosso código é algo muito importante, para cada tarefa que está sendo solicitada for concluída, faça um commit para o seu repositório. 35 | 36 | [Referência a respeito do GIT](https://rogerdudler.github.io/git-guide/index.pt_BR.html) 37 | 38 | ### Camada de Service 39 | 40 | #### Tarefa 🔛 41 | 42 | - Crie uma camada de `Service` para ser usada entre a camada de `Controller` e de `Repository`. 43 | - Atual: *Controller --> Repository* 44 | - Esperado: *Controller --> Service --> Repository* 45 | 46 | *Usar uma camada de `Service` é uma boa prática para separar as responsabilidades no projeto, pois as regras de negocio serão implementada nesta camada no lugar de ficar na camada de Controller (que tem como responsabilidade de ser a camada de entrada e saida de dados).* 47 | 48 | [Referência a respeito de separação de conceitos](https://www.profissionaisti.com.br/entendendo-a-separacao-de-conceitos-separation-of-concerns-soc/#:~:text=Na%20Programa%C3%A7%C3%A3o%20Orientada%20a%20Objetos,subclasses) 49 | 50 | ### CRUD completo 51 | 52 | #### Tarefa 🚀 53 | 54 | - Complete o CRUD com os endpoints de `UPDATE` e `DELETE` usando o CPF como *PathVariable*. 55 | - Atual: *POST + GET* 56 | - Esperado: *POST + GET + PUT + DELETE* 57 | 58 | * * * 59 | 60 | ## 2️⃣ Segunda parte 61 | 62 | ### Uso de DTO 63 | 64 | Vamos agora aplicar o conceito de DTO (Data Transfer Object) ao nosso projeto. Para não utilizar as nossas Entidades como objeto de entrada e saida do nosso projeto. Isso é geralmente considerado uma boa prática no desenvolvimento de API para evitar manipular dados desnecessarios ou retornar dados sigilosos. 65 | 66 | Seguem algumas referências a respeito: 67 | 68 | - [DAO e JPA](https://domineospring.wordpress.com/2015/05/11/facilite-seus-daos-com-o-spring-data-jpa/) 69 | - [DTO](https://medium.com/@msealvial/blindando-sua-api-spring-boot-com-o-padr%C3%A3o-dto-44f97020d1a0) 70 | - [Restrições DTOs](https://dev.to/renatasfraga/java-annotations-no-spring-crie-restricoes-em-suas-dtos-2nfj) 71 | - [DTO e Entidade](https://cursos.alura.com.br/forum/topico-caracteristicas-das-colunas-das-entidades-nos-formularios-dtos-no-momento-da-validacao-88815) 72 | - [Diferença entre os patterns PO, POJO, BO, DTO e VO](https://www.devmedia.com.br/diferenca-entre-os-patterns-po-pojo-bo-dto-e-vo/28162) 73 | 74 | #### Tarefa 🏗 75 | 76 | - Crie os DTOs para usar como objetos de requisição (`UserForm`) e respostas (`UserResponse`) na camada de `Controller`, e faça a adequação dos objetos (DTO para Entidades e vice versa) na camada de `Service`. 77 | 78 | ### Uso de anotações de validações 79 | 80 | Quando usamos DTOs, queremos aproveitar para validar que os dados enviados para nossa API sejam válidos. Para isso, podemos usar anotações que podem avaliar o formato nos quais os campos foram preenchidos. 81 | 82 | Seguem algumas referências a respeito: 83 | 84 | - [Validador Spring](https://www.zup.com.br/blog/spring-validation-o-que-e?utm_source=google-chat&utm_medium=interno&utm_campaign=gc-geral) 85 | - [Validador dados com anotações](https://www.devmedia.com.br/bean-validation-1-1-validando-dados-com-anotacoes/30070) 86 | - [Bean validation](https://emmanuelneri.com.br/2017/05/30/criando-validacoes-de-bean-validation-customizadas/) 87 | - [Validador Hibernate](https://www.devmedia.com.br/hibernate-validator-validando-dados-no-back-end-com-anotacoes/37979) 88 | - [Validar CPF](https://www.devmedia.com.br/validando-o-cpf-em-uma-aplicacao-java/22097) 89 | - [Regex](https://medium.com/@alexandreservian/regex-um-guia-pratico-para-express%C3%B5es-regulares-1ac5fa4dd39f) 90 | - [Mapeamento Hibernate (DAO)](https://www.devmedia.com.br/mapeamento-hibernate-configurando-tabelas-e-colunas/29526) 91 | - [Validando requisições e tratando exceções no Spring Boot](https://marioalvial.medium.com/validando-requisi%C3%A7%C3%B5es-e-tratando-exce%C3%A7%C3%B5es-no-spring-boot-1750ddb1e1cc) 92 | 93 | #### Tarefa ♻️ 94 | 95 | - Atualize as anotações necessárias para validar o formato dos campos de `CPF`, `EMAIL` e `NOME` do DTO de requisição (UserForm). 96 | 97 | * * * 98 | 99 | ## 3️⃣ Terceira parte 100 | 101 | ### Tratamento de Exceções 102 | 103 | Queremos que nossa API sejam fácil de uso e clara no seu funcionamento para quem for consumir ela. Para isso, é importante garantir que os erros esperados e/ou inesperados sejam tratados de forma amigáveis. Uma boa prática é usar Exception Handlers para isso. 104 | 105 | Seguem algumas referências: 106 | 107 | - [Exception Handlers](https://qastack.com.br/programming/28902374/spring-boot-rest-service-exception-handling) 108 | - [Exception Java](https://www.devmedia.com.br/trabalhando-com-excecoes-em-java/27601) 109 | - [Tratar Exceções Java](https://www.devmedia.com.br/como-tratar-excecoes-na-linguagem-java/39163) 110 | 111 | #### Tarefa 🔎 112 | 113 | - Crie uma classe de `Exception Handler` para retornar `mensagens` e `http status` amigáveis caso erros esperados ou inesperados ocorram no uso da sua API. 114 | 115 | ### Testes Unitários 116 | 117 | Testes unitários aumentam a qualidade de nosso código, eles testam o funcionamento de nossos métodos, um cenário de cada vez (sucessos e erros). 118 | 119 | Seguem algumas referências: 120 | 121 | - [JUnit Tutorial](https://www.devmedia.com.br/junit-tutorial/1432) 122 | - [JUnit](https://www.devmedia.com.br/junit-tutorial/1432) 123 | - [JUnit e os seus primeiros testes](https://medium.com/@guilhermemarcionilo/usando-junit-e-como-come%C3%A7ar-os-seus-primeiros-testes-unit%C3%A1rios-d06db19d5688) 124 | - [Basico Mockito](https://inside.contabilizei.com.br/conceitos-basicos-sobre-mockito-73b931ce0c2c) 125 | - [Testando código Java com Mockito](https://medium.com/cwi-software/testando-seu-c%C3%B3digo-java-com-o-mockito-framework-8bea7287460a) 126 | - [Testes Unitarios em Controller](https://dev.to/luizleite_/como-fazer-testes-unitarios-em-controllers-de-um-app-spring-boot-1bbm) 127 | 128 | #### Tarefa ⚙️ 129 | 130 | - Implementar os testes unitários da camada de `Service` e de `Controller` da API. 131 | 132 | * * * 133 | 134 | ## 4️⃣ Quarta parte 135 | 136 | ### Documentação 137 | 138 | Uma das habilidades mais importantes que um bom profissional de software deve ter é da escrita de documentações de alta qualidade. Para muitos, essa é uma tarefa difícil e traumática. Por exemplo, se uma API não for bem documentada, provavelmente, seus usuários encontrarão dificuldades para entender o seu funcionamento. Isso certamente influenciará na utilização dos serviços oferecidos em sua API. 139 | 140 | Seguem algumas referências a respeito do Swagger, uma ferramenta permitindo você automatizar a criação da sua documentação: 141 | 142 | - [Dev Eficiente - Configure e utilize o Swagger para documentar e testar seus endpoints](https://www.youtube.com/watch?v=0KCuW3ntI-U) 143 | - [Documentando uma API Spring Boot com o Swagger](https://www.treinaweb.com.br/blog/documentando-uma-api-spring-boot-com-o-swagger) 144 | - [Spring Boot e Swagger, documentando e testando a sua API REST](http://www.ciceroednilson.com.br/spring-boot-e-swagger-documentando-e-testando-a-sua-api-rest/) 145 | 146 | #### Tarefa 📚 147 | 148 | - Automatizar a documentação dos endpoints da API usando `Swagger`. 149 | 150 | * * * 151 | 152 | ## 5️⃣ Quinta Parte 153 | 154 | Após ter implementado as 4 primeiras partes do desafio com um CRUD completo de gerenciamento de usuário, escolhe qual tipo de API desenvolver baseado nele, dentro da lista abaixo: 155 | 156 | - Nível 1: [API de Loteria](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/LOTERIA.md) 157 | - Nível 2: [API de Endereços](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/ENDERECO.md) 158 | - Nível 3: [API de Vacinas](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/VACINA.md) 159 | - Nível 4: [API de Banco](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/BANCO.md) 160 | - Nível 5: [API de Veículos](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/VEICULOS.md) 161 | 162 | ## 6️⃣ Sexta Parte 163 | 164 | Caso tenha implementado a quinta parte toda e quiser ir além, segue um sugestão de melhoria do nível 2 (API de cadastro de endereços) 165 | 166 | - [API de Imobiliária](https://github.com/GuillaumeFalourd/java-training-api/tree/main/APIs/IMOBILIARIA.md) 167 | 168 | * * * 169 | 170 | ## 💡 Bônus 171 | 172 | Quando trabalhamos com Java e Banco de Dados (BDD), é muito importante ter um conhecimento básico sobre SQL pois é necessário interagir com o BDD no cotidiano para buscar informações ou resolver problemas. 173 | 174 | Seguem algumas referências a respeito: 175 | 176 | - [Guia completo SQL](https://www.devmedia.com.br/guia/guia-completo-de-sql/38314) 177 | - [Dicas SQL](https://medium.com/@alexandre.malavasi/25-dicas-e-boas-pr%C3%A1ticas-de-banco-de-dados-para-desenvolvedores-7a60bfc28f1f) 178 | - [Boas práticas SQL](https://www.devmedia.com.br/boas-praticas-de-programacao-pl-sql-e-um-pouco-de-tunning-dia-a-dia/2424) 179 | - [FAQ SQL](https://www.luis.blog.br/20-perguntas-e-respostas-sobre-a-linguagem-sql-para-banco-de-dados.html) 180 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2021 Guillaume Falourd 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # java-training-api 2 | 3 | Esse repositório disponibiliza uma versão zero de uma API de cadastro de usuários (Users) na pasta [SRC](https://github.com/GuillaumeFalourd/java-training-api/tree/main/src) *a ser melhorada*. 4 | 5 | ## DESAFIOS 6 | 7 | Os desafios podem ser encontrado no arquivo [DESAFIOS.md](https://github.com/GuillaumeFalourd/java-training-api/tree/main/DESAFIOS.md) e correspondem (atualmente) ao nível de conhecimento esperado por desenvolvedores **JUNIORS**. 8 | 9 | ## Requisitos 10 | 11 | - Maven 12 | - Spring 13 | - Java 8 (11 melhor) 14 | - Hibernate 15 | - JPA 16 | 17 | Baixar as dependências: na raiz do projeto: executar o comando `mvn clean install`. 18 | 19 | Para rodar a aplicação localmente, executar o metodo `main` da classe [TrainingApiApplication.java](https://github.com/GuillaumeFalourd/java-training-api/tree/main/src/main/java/br/com/training/TrainingApiApplication.java). 20 | 21 | ## Endpoint disponíveis (v0) 22 | 23 | ### Criar usuário 24 | 25 | **POST:** `http://localhost:8080/users` com *body*: 26 | 27 | ```json 28 | { 29 | "name":"Name", 30 | "cpf":"cpf", 31 | "email":"email", 32 | "birthDate":"1900-01-01" 33 | } 34 | ``` 35 | 36 | ### Obter usuário com CPF 37 | 38 | **GET:** `http://localhost:8080/users/{cpf}` vai retornar: 39 | 40 | ```json 41 | { 42 | "id": 1, 43 | "name":"Name", 44 | "cpf":"cpf", 45 | "email":"email", 46 | "birthDate":"1900-01-01" 47 | } 48 | ``` 49 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 2.4.3 10 | 11 | 12 | br.com.training 13 | training-api 14 | 0.0.1-SNAPSHOT 15 | training-api 16 | Training API 17 | 18 | 11 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-web 24 | 25 | 26 | 27 | org.springframework.boot 28 | spring-boot-devtools 29 | runtime 30 | true 31 | 32 | 33 | org.springframework.boot 34 | spring-boot-starter-test 35 | test 36 | 37 | 38 | org.springframework.boot 39 | spring-boot-starter-data-jpa 40 | 41 | 42 | org.springframework.boot 43 | spring-boot-starter 44 | 45 | 46 | com.h2database 47 | h2 48 | runtime 49 | 50 | 51 | org.springframework.boot 52 | spring-boot-starter-validation 53 | 54 | 55 | org.hibernate 56 | hibernate-validator 57 | 7.0.1.Final 58 | 59 | 60 | 61 | 62 | 63 | 64 | org.springframework.boot 65 | spring-boot-maven-plugin 66 | 67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /src/main/java/br/com/training/TrainingApiApplication.java: -------------------------------------------------------------------------------- 1 | package br.com.training; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class TrainingApiApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(TrainingApiApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/br/com/training/controller/UserController.java: -------------------------------------------------------------------------------- 1 | package br.com.training.controller; 2 | 3 | import javax.validation.Valid; 4 | 5 | import org.springframework.web.bind.annotation.*; 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.http.HttpStatus; 8 | 9 | import br.com.training.model.User; 10 | import br.com.training.repository.UserRepository; 11 | 12 | @RestController 13 | @RestControllerAdvice 14 | @RequestMapping("/users") 15 | public class UserController { 16 | 17 | @Autowired 18 | private UserRepository userRepository; 19 | 20 | @PostMapping 21 | @ResponseStatus(HttpStatus.CREATED) 22 | public User createUser(@RequestBody @Valid User user) { 23 | return userRepository.save(user); 24 | } 25 | 26 | @GetMapping (value = "/{cpf}") 27 | @ResponseStatus(HttpStatus.OK) 28 | public User getUser (@PathVariable String cpf){ 29 | return userRepository.findByCpf(cpf); 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/br/com/training/model/User.java: -------------------------------------------------------------------------------- 1 | package br.com.training.model; 2 | 3 | import java.io.Serializable; 4 | import java.time.LocalDate; 5 | import java.time.format.DateTimeFormatter; 6 | 7 | import javax.persistence.Column; 8 | import javax.persistence.Entity; 9 | import javax.persistence.GeneratedValue; 10 | import javax.persistence.GenerationType; 11 | import javax.persistence.Id; 12 | 13 | import org.springframework.core.convert.converter.Converter; 14 | import org.springframework.stereotype.Component; 15 | 16 | @Entity 17 | public class User implements Serializable { 18 | 19 | private static final long serialVersionUID = 1L; 20 | 21 | @Id 22 | @GeneratedValue(strategy = GenerationType.IDENTITY) 23 | private Long id; 24 | 25 | @Column(nullable = false) 26 | private String name; 27 | 28 | @Column(nullable = false, unique = true) 29 | private String email; 30 | 31 | @Column(nullable = false, unique = true) 32 | private String cpf; 33 | 34 | @Column(nullable = false) 35 | private LocalDate birthDate; 36 | 37 | @Component 38 | public class LocalDateSpringConverter implements Converter { 39 | 40 | @Override 41 | public LocalDate convert(String value) { 42 | if (value != null) { 43 | DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd"); 44 | return LocalDate.parse(value, formatter); 45 | } else { 46 | return null; 47 | } 48 | } 49 | } 50 | 51 | public LocalDate getBirthDate() { 52 | return birthDate; 53 | } 54 | 55 | public void setBirthDate(LocalDate birthDate) { 56 | this.birthDate = birthDate; 57 | } 58 | 59 | public Long getId() { 60 | return id; 61 | } 62 | 63 | public void setId(Long id) { 64 | this.id = id; 65 | } 66 | 67 | public String getName() { 68 | return name; 69 | } 70 | 71 | public void setName(String name) { 72 | this.name = name; 73 | } 74 | 75 | public String getEmail() { 76 | return email; 77 | } 78 | 79 | public void setEmail(String email) { 80 | this.email = email; 81 | } 82 | 83 | public String getCpf() { 84 | return cpf; 85 | } 86 | 87 | public void setCpf(String cpf) { 88 | this.cpf = cpf; 89 | } 90 | 91 | @Override 92 | public int hashCode() { 93 | final int prime = 31; 94 | int result = 1; 95 | result = prime * result + ((id == null) ? 0 : id.hashCode()); 96 | return result; 97 | } 98 | 99 | @Override 100 | public boolean equals(Object obj) { 101 | if (this == obj) 102 | return true; 103 | if (obj == null) 104 | return false; 105 | if (getClass() != obj.getClass()) 106 | return false; 107 | User other = (User) obj; 108 | if (id == null) { 109 | if (other.id != null) 110 | return false; 111 | } else if (!id.equals(other.id)) 112 | return false; 113 | return true; 114 | } 115 | 116 | } 117 | -------------------------------------------------------------------------------- /src/main/java/br/com/training/repository/UserRepository.java: -------------------------------------------------------------------------------- 1 | package br.com.training.repository; 2 | 3 | import org.springframework.data.jpa.repository.JpaRepository; 4 | import org.springframework.stereotype.Repository; 5 | 6 | import br.com.training.model.User; 7 | 8 | @Repository 9 | public interface UserRepository extends JpaRepository { 10 | 11 | User findByCpf(String cpf); 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.jpa.show-sql=true 2 | -------------------------------------------------------------------------------- /src/test/java/br/com/training/TrainingApiApplicationTest.java: -------------------------------------------------------------------------------- 1 | package br.com.training; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | public class TrainingApiApplicationTest { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | } 13 | --------------------------------------------------------------------------------