POSTNOTES - API CRUD Recados

Este repositório contém as informações e arquivos necessários para o uso da API PostNotes para CRUD de Recados, que consiste na criação e login de usuário e na criação, listagem, atualização e exclusão de recados.

Demonstração

PostNotes

Documentação

Postman

Endpoints

Rota padrão

  GET /

Retorna uma mensagem de boas-vindas.

Signup

  POST /signup

Cria um novo usuário.

Login

  POST /login

Autentica um usuário existente.

Listar Usuários

  GET /users

Retorna todos os usuários cadastrados.

Criar Recado

  POST /message

Cria um novo recado. Necessita de autenticação.

Listar Recados

  GET /message/:email

Retorna os recados do usuário autenticado. Necessita de autenticação. Informa paginação com dados fornecidos por query params ou padrão com início na página 1 e 10 itens por página.

Atualizar Recado

  PUT /message/:id

Atualiza um recado específico pelo ID.

Deletar Recado

  DEL /message/:id

Deleta um recado específico pelo ID.

Uso

Pela documentação, clicar em Run in Postman. Pelo modelo, gravação de dados em localStorage e Render.

Instalação

Clonar o repositório

  git clone https://github.com/JoannaBraccini/PostNotes-API

Instalar as depêndencias do projeto

  npm install

Iniciar o projeto

  npm run dev