README-pt-br.md

mock-user-auth

---

Mock-User-Auth é uma API de autenticação de usuário mock desenvolvida em Nodejs e Express utilizando JWT como autenticador na versão ES6 do JavaScript.

Objetivo: pode ser usado para ajudar no desenvolvimento do front-end. É simples e rápido, você só precisa seguir os passos abaixo.

Ferramentas: Node.js | Express.js | Mocha | Chai | Istanbul

Requerimentos

• Node.js 11.x ✅
• Npm 6.x ✅

Npm

1 - Instalando pacote via npm:

$ npm i --save mock-user-auth

2 - Criando script no package.json:

 {
   "script": {
     "dev": "nodemon ./node_modules/mock-user-auth/bin/www.js"
   }
 }

3 - Iniciando api:

$ npm run dev

Opção: Você pode definir a porta após o comando npm:

$ npm run dev 8080

Instalação do Projeto

Obs.: As seguintes instruções foram testadas na distribuição do Ubuntu.

1 - Depois de clonar o repositório 'git clone' (comando), execute os seguintes comandos para instalar as dependências do projeto:

• user@user:~/diretorio_projeto_clonado/$ npm install
• Instale manualmente as dependências que podem não ter sido instaladas pelo comando acima. ✅

2 - Iniciar aplicação

• use@user:~/diretorio_projeto_clonado/ npm start
• Acesse pelo nevagador http://localhost:3000/api/v1/users

Rotas da API

Ação	Requerido	Método	URL
AUTENTICAR USUÁRIO		POST	/api/v1/auth
CRIAR USUÁRIO		POST	/api/v1/users
OBTER USUÁRIO	Autenticar	GET	/api/v1/users
ATUALIZAR USUÁRIO	Autenticar	PATCH	/api/v1/users
DELETAR USUÁRIO	Autenticar	DELETE	/api/v1/users
DELETAR TODOS USUÁRIOS		DELETE	/api/v1/users

AUTENTICAR USUÁRIO

• REQUISIÇÃO

POST /api/v1/auth

{
  "email": "[email protected]",
  "password": "user123"
}

• RESPOSTA

{
  "token": "eyJhbGciOiJI..."
}

CRIAR USUÁRIO

• REQUISIÇÃO

POST /api/v1/users

{
  "name": "user",
  "email": "[email protected]",
  "password": "user123"
}

• RESPOSTA

{
  "message": "User registered with success",
  "token": "eyJhbGciOiJI..."
}

OBTER USUÁRIO POR TOKEN

• REQUISIÇÃO

GET /api/v1/users

const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);

• RESPOSTA

{
  "id": 46643,
  "name": "user",
  "email": "[email protected]",
  "password": "user123",
  "imageUrl": "https://almsaeedstudio.com/themes/AdminLTE/dist/img/user2-160x160.jpg"
}

ATUALIZAR USUÁRIO POR TOKEN

• REQUISIÇÃO

PATCH /api/v1/users

const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);

{
  "name": "newName",
  "email": "[email protected]",
  "password": "newpassword123"
}

• RESPOSTA

{
  "message": "User updated with success"
}

DELETAR USUÁRIO POR TOKEN

• REQUISIÇÃO

DELETE /api/v1/users

const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);

• RESPOSTA

{
  "message": "User deleted with success"
}

DELETAR TODOS USUÁRIOS

• REQUISIÇÃO

DELETE /api/v1/all-users

{
  "key_admin": "keyadmin123"
}

• RESPOSTA

{
  "message": "Users deleted with success"
}

Autor

• Thiago Luiz Pereira Nunes (ThiagoLuizNunes) [email protected]

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para obter detalhes

Criado por ThiagoLuizNunes 2019.

---