En este trabajo se construyó una api desde cero, usando distintas herramientas de nodeJS, express y otras dependencias como zod, randomUUID y encriptación de las contraseñas para brindar mayor seguridad.
Se crearon dos archivos JSON que almacenan datos de usuarios y otro para almacenar los datos de la temática seleccionada: memes.
Se proyectó la idea de hacer una red social, donde los usuarios puedan realizar distintas acciones sobre los memes y los usuarios. Para ello es necesario tener una cuenta, luego loguearse con usuario y contraseña. Esto les administrará un token único para cada usuario y cada sesión iniciada, que será fundamental para realizar las acciones que el usuario desee.
Para ejecutar estos procesos, poder ver la información solicitada y realizar las distintas acciones del sistema, debemos levantar el servidor con un comando de node. Aquí se podrán apreciar los comandos de ejecución que se enviarán por consola:
| COMANDO DE EJECUCIÓN | TIPO DE ACCESO |
|---|---|
| npm run start | USUARIOS |
| npm run dev | DESARROLLADORES |
| npm run build | COMPILADO/PRODUCCIÓN |
- Para obtener toda la lista de usuarios.
- Para obtener la información de un usuario en particular.
- Para modificar los datos de mi propio usuario.
- Para borrar mi usuario.
- Para cerrar la sesión.
- Para crear un nuevo meme.
- Para modificar los datos de un meme.
- Para borrar un meme.
- Para likear un meme.
- Registrar un usuario.
- Hacer el login de una cuenta. Para esta acción se requiere estar registrado.
- Mostrar toda la lista de memes.
- Buscar un meme por su ID.
- Mostrar el top 5 de memes más likeados.
- Mostrar la versión de la api.
- Mostrar un ping que muestre la información del servidor y su configuración.
Los desarrolladores que deseen probar el sistema, deben contar con nodeJs y se instelarán las dependecias adjuntas en el packaje.json. Se podrá hacer un PING con la herramienta OS de node, con el endpoint correspondiente. Aunque también el sistema ya tiene agregado otro ping para cada petición con la dependencia Morgan. Al compilar con el comando, y ejecutar desde el sistema compilado mejora la calidad y la rapidez de las respuestas a las peticiones. Por último, se agregó un archivo 'testing-postman-apimemes.json' para pruebas en POSTMAN, que se puede importar para realizar las peticiones de prueba.
# PRUEBAS API PARA MI SISTEMA - API MEMES
### Api Info:
GET http://localhost:1947/api/
### Ping con OS-node:
GET http://localhost:1947/api/ping
### Búsqueda por usuario (requiere token):
GET http://localhost:1947/api/users/USUARIO1
Authorization: token123
### Crear un usuario:
POST http://localhost:1947/api/users/register
Content-Type: application/json
{
"mail": "[email protected]",
"username": "test10",
"password": "123456789",
"token": "",
"interests": ["animals", "kids", "comics"]
}
### Login de un usuario: (FUNCIONA BIEN CON POSTMAN)
POST http://localhost:1947/api/users/login
Content-Type: application/json
{
"username": "test10",
"password": "12345678"
}
### Modificar un usuario: (FUNCIONA BIEN CON POSTMAN)
PATCH http://localhost:1947/api/users/test10
Content-Type: application/json
{ "username": "test10",
"mail": "[email protected]"
}
Authorization: eca06d1d-a389-4313-a1e4-7d2abae07449
### Eliminar un usuario: (FUNCIONA BIEN CON POSTMAN)
DELETE http://localhost:1947/api/users/test10
CONTENT-TYPE: application/json
{"username": "test10"}
Authorization: eca06d1d-a389-4313-a1e4-7d2abae07449
### Logout de usuario: (FUNCIONA BIEN CON POSTMAN)
DELETE http://localhost:1947/api/users/logout
Content-Type: application/json
{
"username": "test001"
}
Authorization: 66d628c5-b3a3-475c-9470-22d94536f0d4
### Obtener todos los memes:
GET http://localhost:1947/api/memes
### Obtener memes por author, con query params:
GET http://localhost:1947/api/memes/?author=test005
### Obtener meme por ID:
GET http://localhost:1947/api/memes/aaf05466-1dc1-4958-bcad-16175314971d
### Crear un nuevo meme:(FUNCIONA BIEN CON POSTMAN)
POST http://localhost:1947/api/memes/
Content-Type: application/json
{
"id": "",
"name": "ya wey",
"categories": ["girl", "humor", "scenes"],
"author": "test005",
"imageUrl": "https://i.kym-cdn.com/entries/icons/original/000/045/575/blackcatzoningout_meme.jpg",
"likes": [""]
}
Authorization: fbbcacda-aa9a-4c37-8012-ceaaa44bd1e5
### Modificar un meme:(FUNCIONA BIEN CON POSTMAN)
PATCH http://localhost:1947/api/memes/4475e7ca-3a83-455c-90d9-8804e1d70dcc
Content-Type: application/json
{
"id": "4475e7ca-3a83-455c-90d9-8804e1d70dcc",
"name": "michito",
"categories": ["cats", "faces", "animals"]
}
Authorization: fbbcacda-aa9a-4c37-8012-ceaaa44bd1e5
### Borrar un meme:(FUNCIONA BIEN CON POSTMAN)
DELETE http://localhost:1947/api/memes/aaf05466-1dc1-4958-bcad-16175314971d
Content-Type: application/json
Authorization: fbbcacda-aa9a-4c37-8012-ceaaa44bd1e5
### Dar un like al meme: (FUNCIONA BIEN CON POSTMAN)
PATCH http://localhost:1947/api/memes/f258c01f-38e8-4867-8ffb-66f9f16e27de/like
Content-Type: application/json
{
"username": "laura55"
}
Authorization: 66d628c5-b3a3-475c-9470-22d94536f0d4
### Mostrar top 5 de memes más likeados:
GET http://localhost:1947/api/memes/top5
- LINK PARA IMÁGENES ➡️ Know Your Meme.
- PINTEREST PARA IMÁGENES ➡️ PINTEREST.
- EMOJIS PARA PERSONALIZAR LAS RESPONSES ➡️Emojipedia.
- VIDEO QUERYPARAMS ➡️ Queryparams Express.
- FORMATO DE UN PING ➡️ Ping en una api.
- INFO PARA EL PING ➡️ Ping con un IP.
- DOCUMENTACIÓN OS EN NODEJS ➡️ Documentación nodeJS - OS.
- INFO DE OS PARA UTILIZAR NETWORKINTERFACES ➡️ NetworkInterfaces os NodeJS
- DOCUMENTACIÓN DE ZOD ➡️ Documentacion npm zod.
- QUERY PARAMS ➡️ Implementación de Query Params en express.
- TIPOS DE ESQUEMAS ERD ➡️ ERD Diagrams.
- ERD tool ➡️ ER diagram tool.
- MODELO EJEMPLO ERD ➡️ ERD Example.
- MODELO EJEMPLO ERD ➡️ ERD Example.
- 📝Autor: Ailén Páez.