:pencil: Documentação

Este projeto foi implementado na etapa do teste técnico no processo seletivo da Attornatus Procuradoria Digital para a vaga de Desenvolvedor Back End - Java. Seguindo as especificações dadas no teste, o projeto é uma simples API destinada ao cadastro de Pessoas e Endereços, servindo as funcionalidades obrigatórias exigidas no teste e outras implementadas pelo desenvolvedor da API por decisão de projeto.

O projeto conta com o CRUD completo das seguintes entidades:

• Estados
• Cidades
• Pessoas
• Endereços

A documentação completa do projeto foi feita utilizando as ferramentas da biblioteca Spring Doc, dependência do projeto, através do Swagger UI com as especificações do Open API 3.0, afim de prover maior entendimento para os consumidores da API. Para acessar a documentação, faça o clone do projeto para a sua máquina, inicie a aplicação (pode demorar um pouco, pois será feito o download das dependências na primeira vez) e após subir o serviço abra seu navegador e digite: http://localhost:8080/swagger-ui/index.html. Se preferir, os testes podem ser feitos na própria página da documentação, onde contém as explicações devidas para consumir cada endpoint.

:hammer: Funcionalidades

:package: Estados:

• Cadastra estados
• Consulta estados
• Lista todos os estados cadastrados
• Lista todas as cidades de um estado
• Edita estados
• Exclui estados

• :bulb: Detalhes: Não é permitido estados com dados duplicados, nomes só aceitam letras maiúsculas, minúsculas, acentuadas e espaços, UF só aceita 2 letras.

:package: Cidades:

• Cadastra cidades
• Consulta cidades
• Lista todas as cidades cadastradas
• Edita cidades
• Exclui cidades

• :bulb: Detalhes: Nomes só aceitam letras maiúsculas, minúsculas, acentuadas e espaços.

:package: Pessoas:

• Cadastra pessoas
• Consulta pessoas
• Lista todas as pessoas cadastradas
• Edita pessoas
• Exclui pessoas