https://github.com/thiagoluiznunes/mock-user-auth
Mock-User-Auth is a mock user authentication API developed in Nodejs and Express using JWT as authenticator using the ES6 version of JavaScript.
https://github.com/thiagoluiznunes/mock-user-auth
api-server authentication babel chai codeclimate continuous-integration coverage express istanbul jwt maintenance mocha mock-server mockup nodejs nyc quality tdd travis-ci
Last synced: 15 days ago
JSON representation
Mock-User-Auth is a mock user authentication API developed in Nodejs and Express using JWT as authenticator using the ES6 version of JavaScript.
- Host: GitHub
- URL: https://github.com/thiagoluiznunes/mock-user-auth
- Owner: thiagoluiznunes
- License: mit
- Created: 2019-04-05T00:51:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T01:29:31.000Z (8 months ago)
- Last Synced: 2025-02-23T01:04:10.559Z (2 months ago)
- Topics: api-server, authentication, babel, chai, codeclimate, continuous-integration, coverage, express, istanbul, jwt, maintenance, mocha, mock-server, mockup, nodejs, nyc, quality, tdd, travis-ci
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/mock-user-auth
- Size: 62.5 KB
- Stars: 6
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README-pt-br.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mock-user-auth
[](https://badge.fury.io/js/mock-user-auth)
[](https://travis-ci.org/thiagoluiznunes/mock-user-auth)
[](https://codeclimate.com/github/thiagoluiznunes/mock-json-server/maintainability)
[](https://codeclimate.com/github/thiagoluiznunes/mock-json-server/test_coverage)
[](https://codeclimate.com/github/thiagoluiznunes/mock-json-server/issues)
---
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](http://nodejs.org/en/)** :white_check_mark:
* **[Npm 6.x](https://www.npmjs.com/)** :white_check_mark:
### Npm ###
1 - Instalando pacote via npm:
```
$ npm i --save mock-user-auth
```
2 - Criando script no package.json:
```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.** :white_check_mark:
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
```
```json
{
"email": "[email protected]",
"password": "user123"
}
```
* RESPOSTA
```json
{
"token": "eyJhbGciOiJI..."
}
```
#### CRIAR USUÁRIO ####
* REQUISIÇÃO
```
POST /api/v1/users
```
```json
{
"name": "user",
"email": "[email protected]",
"password": "user123"
}
```
* RESPOSTA
```json
{
"message": "User registered with success",
"token": "eyJhbGciOiJI..."
}
```
#### OBTER USUÁRIO POR TOKEN ####
* REQUISIÇÃO
```
GET /api/v1/users
```
```javascript
const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);
```
* RESPOSTA
```json
{
"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
```
```javascript
const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);
```
```json
{
"name": "newName",
"email": "[email protected]",
"password": "newpassword123"
}
```
* RESPOSTA
```json
{
"message": "User updated with success"
}
```
#### DELETAR USUÁRIO POR TOKEN ####
* REQUISIÇÃO
```
DELETE /api/v1/users
```
```javascript
const token = 'eyJhbGciOiJI...';
req.setRequestHeader('Authorization', token);
```
* RESPOSTA
```json
{
"message": "User deleted with success"
}
```
#### DELETAR TODOS USUÁRIOS ####
* REQUISIÇÃO
```
DELETE /api/v1/all-users
```
```json
{
"key_admin": "keyadmin123"
}
```
* RESPOSTA
```json
{
"message": "Users deleted with success"
}
```
### Autor
* Thiago Luiz Pereira Nunes ([ThiagoLuizNunes](https://github.com/ThiagoLuizNunes)) [email protected]
### Licença
Este projeto está licenciado sob a licença MIT - consulte o arquivo [LICENSE.md](LICENSE.md) para obter detalhes
>Criado por **[ThiagoLuizNunes](https://www.linkedin.com/in/thiago-luiz-507483112/)** 2019.
---