Code Monkey home page Code Monkey logo

authentication-api's Introduction

🔒 Authentication (API)

🚀 Tecnologias

Este projeto foi desenvolvido com as seguintes tecnologias:

  • TypeScript
  • Express
  • Prisma
  • JWT
  • Joi
  • Docker

💻 Projeto

Este é um projeto de estudo, com o objetivo de praticar o fluxo de autenticação por meios de tokens JWT.

Neste repositório, desenvolvi uma que API possui sistema de registro e login de usuários, gerando os tokens de acesso e os validando. Veja mais detalhes sobre os endpoints.

Este repositório faz parte do projeto :octocat: Authentication Project.

📥 Instalando o Projeto

Programas necessários

  • Git (ou baixe o repositório como .zip)
  • Node (preferência na versão LTS)
  • Docker

Etapas

  • Vá até a pasta do projeto authentication-api e rode o comando yarn ou npm install para instalar as dependências do projeto;
  • Crie o arquivo .env na raíz do projeto e adicione as variáveis necessárias como mostra o arquivo .env.example;
  • Com as suas variáveis de ambiente configuradas e com o docker instalado, suba o container do banco de dados na sua máquina, usando o docker-compose, com o seguinte comando:
    docker compose up -d
  • Agora precisaremos criar as tabelas do nosso banco de dados. Vamos utilizar as migrations geradas pelo prisma:
    npx prisma migrate dev
  • Por fim, rode o projeto com o comando yarn start ou npm start;

🌐 API

Registro de Usuário /users [POST]

  • Request (application/json)

  • Response 201 (application/json)

    • Body
      {
        "user": {
          "id": "e4b1774f-908f-4838-9054-e82db54b95b6",
          "name": "any_name",
          "email": "[email protected]"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      }

Informação do Usuário /users/me [GET]

  • Request (application/json)

    • Headers
      Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      
  • Response 200 (application/json)

    • Body
      {
        "user": {
          "id": "e4b1774f-908f-4838-9054-e82db54b95b6",
          "name": "any_name",
          "email": "[email protected]"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      }

Atualizar informações básicas do Usuário /users/me [PUT]

  • Request (application/json)

    • Headers
      Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      
    • Body
      {
        "name": "other_name",
        "email": "[email protected]"
      }
  • Response 200 (application/json)

    • Body
      {
        "user": {
          "id": "e4b1774f-908f-4838-9054-e82db54b95b6",
          "name": "other_name",
          "email": "[email protected]"
        }
      }

Atualizar senha do Usuário /users/me/password [PUT]

  • Request (application/json)

    • Headers
      Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      
    • Body
      {
        "oldPassword": "any_password",
        "password": "new_password"
      }
  • Response 200 (application/json)

    • Body
      {
        "user": {
          "id": "e4b1774f-908f-4838-9054-e82db54b95b6",
          "name": "other_name",
          "email": "[email protected]"
        }
      }

Autenticar Usuário /login [POST]

  • Request (application/json)

  • Response 200 (application/json)

    • Body
      {
        "user": {
          "id": "e4b1774f-908f-4838-9054-e82db54b95b6",
          "name": "other_name",
          "email": "[email protected]"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      }

authentication-api's People

Contributors

jotahdavid avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.