(Creat Read Update Delete - CRUD API RESTFULL)
Projeto TODO-LIST API (Backend) RESTFUL API simples em JAVA que possibilita inserir, armazenar e atualizar tarefas e o status da mesma.
Toda tarefa deve possuir um status (pending ou completed);
A API persisti os dados em um banco de dados;
A API disponibiliza uma rota para listagem das tarefas e seu status (GET /todo);
A API fornece uma rota para validar o funcionamento de seus componentes (GET /healthcheck);
A API fornece uma rota com indicadores de performance da API (ex: volume de requisições atendidas, tempo médio de serviço em milissegundos, etc) (GET /metrics);
Desenvolvimento do Frontend para input dos dados na API esta em andamento no momento.
Este projeto pode ser visualizado e executado em um computador local. Para isso o computador precisa ter instalados previamente os seguintes programas:
-- Docker, Docker Compose e um gerenciador de requisições HTTP ex: Postman, Insomia, ou algo do tipo.
Com estes requisitos basicos atendidos, siga as orientações a abaixo:
- crie um diretório em um local de sua preferencia no seu computador;
- na pagina principal deste projeto no site do gitHub você deve conseguir localizar um botão verde escrito "Code";
- clique nesse botão verde e selecione na janela pop-up que abrir a opção que melhor te servir e copie o link que estiver dentro da janela.
- ex: SSH -> [email protected]:preto115/Projetos-Java.git
- volte á janela do seu diretorio onde deseja clonar o projeto e digite
- o seguinte "git clone " e cole logo após o link que vc copiou do projeto, e tecle ENTER:
localhost:$ git clone [email protected]:preto115/todo-list.git
- após o git concluir a clonagem, navegue para dentro da pasta clonada:
- e em seguida digite o seguinte comando:
- pronto agora é so aguardar os containers serem criados. Apos o terminal
- liberar o cursor, e verifcar se os container estão rodando com o seguinte comando:
- deverá ter 3 container parecidos como abaixo, sendo 2 com stasus "UP" (todo-backend e mysql)
- e um outro com status "Restarting" (prometheus) como no print;
Agora basta abrir um programa de monitoramento (execução de requisições HTTP) - ex: Postman ou Insomia e acessar os endPoints relacionados abaixo.
NOTE: é possivel que mesmo estando como status UP, após tentar acessar os endpoints, deve ter algum delay de acesso devido ao seu computador está processando os dados ainda da API e do banco de dados; então dê um tempinho para que a aplicação suba por completo antes de tentar acessar os endPoints.
-
cria tarefas com nome e situação (opcional) da tarefa: -- (POST /todo ) -- ex: { name: "nome da tarefa", status: "completed" }
-
lista todas as tarefas e e seus status: -- (GET /todo )
-
lista tarefas filtrando por nome ou situação: -- ex: (GET /todo?name="nome da tarefa" ) -- ex: (GET /todo?status=pending)
-
lista uma tarefa especifica pelo seu ID -- ex: (GET /todo/1 )
-
deleta uma tarefa especifica através do ID se esta existir no banco de dados -- ex: (DELETE /todo/2 )
-
atualiza uma tarefa existente no banco de dados através do ID -- ex: { name: "nome da tarefa previamente criada", status: "completed" } (PUT /todo/1)
- Requisições de "delete" que forem bem sucedidas aparentemente nao irá retornar nada no corpo da resposta mas terá (STATUS - 202);
- não é possível atualizar ou deletar uma tarefa que não esteja previamente cadastrada no banco de dados; RETORNO(STATUS - 404);
- para atualizar uma tarefa ja cadastrada, só é possível mudar o status entre "pending" ou "completed", nao sendo permitido mudar o nome da tarefa,
para esta situação, o indicado é excluir a tarefa nao desejada e criar uma nova tarefa. para status fora do padrão:
RETORNO(STATUS - 400);
- É possível adicionar uma tarefa com o nome somente e está será registrada com status "pending" no banco de dadosç todavia é possível adicionar uma tarefa com status "completed" para simples controle e monitoramento das tarefas já concluídas.
- Para todas as informações que que não estiverem dentro dos padroes de aceitação válidos dos dados, o RETORNO(STATUS - 400);
- Quaquer outra inserção de dados que a API não estiver preparada para lidar com ela, terá um RETORNO(STATUS - 500);
-
Rota para validar o funcionamento dos componentes da API via Spring Actuator -- (GET /healthcheck)
-
Rota para gerenciamento de métricas com suporte a outros sistemas de monitoramento via Spring Actuator / MicroMeter
- (GET /metrics)
-
Rota para indicadores de performance da API via Prometheus
- (GET /prometheus)
-
Rota para status da API via Spring Actuator
- (GET /info)