luk4x/user-register-api

👥 Users API - A Node API to store Users Interface data | NodeJS, Javascript, ExpressJS...

🇺🇸 English

🇧🇷 Português

👥 Users Project API

Vídeo   |    Tecnologias   |    Sobre   |    Rotas   |    Middlewares   |    Clone   |    Contato

📹 Apresentação em Vídeo do Projeto

user-register-API.mp4

Caso o vídeo apresente algum erro, recarregue a página!
Acesse o projeto online AQUI

🚀 Tecnologias utilizadas

• NodeJS
• ExpressJS
• UUID
• Javascript
• Yarn

📝 Sobre

Assistir o vídeo acima e/ou acessar o projeto online ajudará na compreensão da explicação!

Esse projeto é a API do Users, uma aplicação Web que realiza o cadastro e a gerência de usuários, servindo como base para a sua Interface que desenvolvi essencialmente em ReactJS.

📃 Rotas e Exemplos

• POST /users: Essa rota recebe o nome e a idade do usuário. essas informações são passadas pelo body da requisição, e com base nelas um novo usuário é registrado num array, no seguinte formato:

  {
    name: "Lucas",
    age: 18,
    id: "06d5e912-d672-49ca-92c9-5a4e0e470f15"
  }

  A informação de id é gerada no sistema pela biblioteca uuid e incorporada ao usuário.
  Essa rota também tem uma verificação para impedir que usuários com dados incompletos sejam cadastrados.

• GET /users: Essa rota lista todos os usuários cadastrados no array.

• GET /users/:id: Com base no id enviado, essa rota retorna um usuário específico.

• PUT /users/:id: Com base no id enviado, essa rota pode alterar um, ou todos os dados de um usuário (exceto o id).

• DELETE /users/:id: Com base no id enviado, deleta o usuário que o possui.

• Ao chamar a rota POST /users 2 vezes, passando { name: "Hana", age: 23 } pelo body, o array fica dessa forma:

[
    {
      name: "Hana",
      age: 23,
      id: "05a5913e-h325-da2a-75c9-93f20e02fa19"
    },
    {
      name: "Hana",
      age: 23,
      id: "e671f3a7-4d0a-4c44-b850-c16ab6785e89"
    }
];

• Ao chamar a rota GET /users/e671f3a7-4d0a-4c44-b850-c16ab6785e89, o retorno é:

{
  name: "Hana",
  age: 23,
  id: "e671f3a7-4d0a-4c44-b850-c16ab6785e89"
};

🔑 Middlewares

• checkUserId: Sua função é verificar se o ID recebido existe e tomar medidas em caso de inexistência. Ele é usado em todas as rotas que recebem um ID.

• showMethodNUrl: Sua função é mostrar no console o método(GET,POST,PUT,DELETE, etc) e também a url da requisição. Ele é usado em todas as requisições e tem o objetivo apenas de facilitar e organizar o desenvolvimento.

• verifyUserData: Sua função é verificar os dados do usuário enviados pelo body, e tomar medidas caso essa requisição tenha a intenção de modificar dados que o usuário não tem permissão.

📖 Clonando o Projeto

Para clonar e executar este projeto em seu computador, você precisará do Git, Node.js v16.13.2 ou superior, Yarn, e de preferência, um API Client como o Insomnia (mas também pode ser acessado pelo navegador) previamente instalados.
No terminal:

# Clone esse repositório com:
> git clone https://github.com/Luk4x/user-register-API.git

# Entre no repositório com:
> cd user-register-API

# Instale as dependências com: 
> yarn install

# Execute o projeto com:
> yarn app

# Feito isso, você já poderá acessar o projeto pelo link que aparecerá no terminal! (algo como http://localhost:3001/ ou http://127.0.0.1:5173/)

🤝 Contato dos Contribuintes

Vitrine.Dev 🪟 Lucas Maciel 🪧 Vitrine.Dev Lucas Maciel ✨ Nome 👥 Users Project API 🏷️ Tecnologias nodejs, expressjs, javascript, uuid, yarn 📷 Img

Voltar ao Topo