Grupo 107 - API de Login Semana 3

Uso

Esta API cuenta con las siguientes rutas

Listar usuarios (método GET)

'api/user/'

Devuelve un .json con todos los usuarios registrados.

Hacer login (método POST)

'api/auth/signin'

Recibe en el body de la petición los parámetros email y password y devuelve 3 respuestas posibles

• Login exitoso: Estado 200, y devuelve un jwt-token con la información del usuario autenticado.

{
  auth: true,
  accessToken: token,
}

• Usuario no encontrado: Estado 404

{
  auth: false,
  accessToken: null,
  message: 'No existe el usuario en nuestros registros'
}

• No autenticado: Estado 401, cuando el usuario existe pero la contraseña es incorrecta

{
  auth: false,
  accessToken: null,
  message: 'Tus credenciales no coinciden con nuestros registros'
}

Registrar usuarios (método POST)

'api/auth/register'

Recibe en el body de la petición los parámetros name, email y password y devuelve 2 respuestas posibles

• Registro exitoso: Estado 201

{
  message: 'Registro Exitoso'
}

• Usuario existente: Estado 400, si ya existe un usuario con el mismo email

{
  message: 'El usuario ya existe'
}

Pruebas locales

• Clonar el repositorio

git clone https://github.com/MinTIC-Group-107/semana-3-107.git

• Instalar dependencias de javascript

npm install

• Crear una base de datos local o remota y configurar sus credenciales de acceso Ir al archivo config/config.json y modificar los parámetros de acceso a la base de datos de desarrollo

{
    "development": {
        "username": "nombreDeUsuario",
        "password": "miContraseña",
        "database": "nombreBaseDeDatos",
        "host": "miHost",
        "dialect": "mysql"
    },
    "test": {
        "dialect": "sqlite",
        "storage": "./database.sqlite3"
    },
    "production": {
        "dialect": "sqlite",
        "storage": "./database.sqlite3"
    }
}

• Levantar el servidor local de node que por lo general arranca en el puerto 3000

npm run dev

Pruebas en producción

En la siguiente baseURL se encuentra alojada esta API para hacer pruebas

https://mintic-grupo-107-s3.herokuapp.com

Autores

• Manuel Mosquera: [email protected]
• Andrés Restrepo: [email protected]
• Clara Inés Marín: [email protected]
• Luis Antonio Parrado: [email protected]