API-Notes By JACL_DEV

Para proyecto de Jóvenes Creativos

URL de Producción

https://api-notes-production.up.railway.app/

Comandos para iniciar API

1. npm run start :
   Levanta la api en producción y en su respectiva base de datos
2. npm run start:dev :
   Levanta la api en Desarrollo y en su respectiva base de datos
3. npm run start:test :
   Levanta la api para Testing y en su respectiva base de datos

Variables de entorno esenciales :

1. SECRET: se usa para encriptar las contraseñas que se almacenaran en DB
   
2. DB_URI: Dirección para la colección a la DB
   
3. DB_URI_TEST: Dirección para la colección a la DB para testing
   

Rutas para peticiones de Usuario:
1.POST api/users/create: Esta ruta crea un nuevo usuario, si no encuentra datos duplicados
data {
name,
nameuser,
password
}

2.POST api/users/login: Esta ruta valida que el usuario este registrado y devuelve una cadena encriptada para uso de autorización
data {
nameuser,
password
}

3.GET api/users/oneUser: Esta ruta permite obtener los datos de un usuario el cual ya tiene autorización, la cual se envía en las cabecera de la petición http
Headers {
Authorization,
}

Rutas para peticiones de Notas:
1.POST api/notes/create: Esta ruta podrás crear notas siempre y cuando tengas la autorización enviada en la cabecera de la petición http
Headers {
Authorization,
}
data {
title,
content,
}

2.GET api/notes/: Esta ruta podrás obtener todas las notas del usuario
Headers {
Authorization,
}
data {}

3.GET api/notes/one/: Esta ruta podrás obtener una nota del usuario del usuario
Headers {
Authorization,
}
data {}

4.DELETE api/notes/: Esta ruta podrás borrar una nota del usuario del usuario
Headers {
Authorization,
Id,
}
data {}

5.PUT api/notes/: Esta ruta podrás actualizar una nota del usuario del usuario
Headers {
Authorization,
Id,
}
data {}