Detalhes das rotas para usuário - eduardosdl/LibraryAPI GitHub Wiki

  • Rota para criação de usuário

       Método POST - http://localhost:3000/user/new
    
    • Privacidade da rota
       - Rota pública, acessivel sem o token
    
    • Informações que devem ser enviadas
       {
          "name": "<nome>",
          "email": "<email>",
          "password": "<senha>",
          "confirmPassword": "<confimação_de_senha>"
       }
    
    • Informações que constaram na resposta
       {
          "msg": "Usuário criado e logado com sucesso",
          "data": {
             "id": "<id>",
             "name": "<nome>",
             "email": "<email>"
          },
          "token": "<token>"
       }
    
  • Rota para login de usuário

       Método GET - http://localhost:3000/user/new
    
    • Privacidade da rota
       - Rota pública, acessivel sem o token
    
    • Informações que devem ser enviadas
       Deve conter o login e a senha do usuário,
       codificados com Base64 e enviados através do header da requesição
    
    • Informações que constaram na resposta
       {
          "msg": "Usuário criado e logado com sucesso",
          "data": {
             "id": "<id>",
             "name": "<nome>",
             "email": "<email>"
          },
          "token": "<token>"
       }
    
  • Rota para edição de usuário

       Método PATCH - http://localhost:3000/user/edit/<id_do_usuário>
    
    • Privacidade da rota
       - Acessivel apenas para usuários conectados
       - Validação feita através do token
    
    • Informações que devem ser enviadas
       {
          "name": "<novo_nome>",
          "email": "<novo_email>",
          "password": "<senha>"
       }
    
    • Informações que constaram na resposta
       {
          "msg": "Usuário alterado com sucesso",
          "oldData": {
             "name": "<nome_antigo>",
             "email": "<email_antigo>"
          },
          "newData": {
             "name": "<novo_nome>",
             "email": "<novo_email>"
          }
       }
    
  • Rota para edição de senha do usuário

       Método PATCH - http://localhost:3000/user/edit/pass
    
    • Privacidade da rota
       - Acessivel apenas para usuários conectados
       - Validação feita através do token
    
    • Informações que devem ser enviadas
       {
          "email": "<email>",
          "password": "<senha_atual>",
          "newPassword": "<nova_senha>"
       }
    
    • Informações que constaram na resposta
       {
          "msg": "senha alterada co sucesso",
       }
    
  • Rota para fazer/desfazer administrador

       Método PATCH - http://localhost:3000/user/makeadm/<id_do_usuário>/<true_ou_false>
    
    • Privacidade da rota
       - Acessivel apenas para admnistradores
       - Validação feita através do token
    
    • Informação que deve ter na URL
       - O ultimo parametro da URL que irá indicar se o privilégio deve ser aplicado ou retirado
       - Caso seja 'true' o privilégio será aplicado
       - Caso seja 'false' o privilégio será retirado
    
    • Informações que constaram na resposta
       {
          "data": {
             "id": "<id>",
             "name": "<nome>",
             "admin": <estado>
          }
       }
    
  • Rota para apagar conta

       Método DELETE - http://localhost:3000/user/del/<id_do_usuário>
    
    • Privacidade da rota
       - Acessivel apenas para usuários conectados
       - Validação feita através do token
    
    • Informações que devem ser enviadas
       {
          "password": "<senha>"
       }
    
    • Informações que constaram na resposta
       {
          "msg": "Usuário apagado com sucesso",
          "data": {
             "id": "<id>",
             "name": "<nome>",
             "email": "<email>"
          }
       }
    
⚠️ **GitHub.com Fallback** ⚠️