Este projeto trata-se de uma implementação de back-end utilizando Java+Spring e comunicação com banco de dados PostgreSQL.
O objetivo do sistema é ser utilizado como plataforma de gerenciamento de pessoas.
Os seguintes end-points são oferecidos para manipulação do sistema:
Método | URL | Ação |
---|---|---|
POST | /person | Cadastrar nova pessoa |
PUT | /person/{id} | Editar informação de pessoa cadastrada |
DELETE | /person/{id} | Apagar registro de uma pessoa |
GET | /person | Listar todas as pessoas cadastradas |
GET | /person/id | Obter informações de uma pessoa específica |
GET | /v2/api-docs | Arquivo do Swagger com o JSON da documentação das rotas |
GET | /swagger-ui.html | Visualização da documentação da API pelo Swagger |
Os métodos de inserção e atualização dos registros de pessoa utilizam o mesmo formato no corpo da requisição, tal como:
{
"name": "some-name",
"documentNumber": "some-document"
}
O formato de retorno do objeto representacional da entidade Pessoa no sistema é dado pelo seguinte esquema:
{
"id": "some-uuid",
"name": "some-name",
"document": {
"number": "some-document-number",
"type": "CPF | CNPJ"
}
}
Para executar o banco de dados do projeto há um arquivo de esqueleto do Docker Compose.
Basta executar o seguinte comando no terminal para disponibilizar o banco de dados:
> docker-compose up -d
![]() Leonardo Braz Desenvolvedor |
---|