API Documentation

Documentación de la API

Se presenta la documentación de la api que permite entender de que forma se va a poder utilizar el servicio, también sirve como requerimiento para los desarrolladores que tomen las tareas

Usuarios

Documentación de la gestión de usuarios

POST /user/

Permite dar de alta un usuario, si bien la plataforma no guarda los usuarios es un paso requerido para poder generar el id (que mantendrá la sesión) que permitirá saber quién es el owner de las salas.

Body

{
   "username": "Pato",
   "picture": "https://joaquindecima.gitlab.io/img/profile.webp",
}

201 Ok

{
   "userId": "uuid",
   "username": "Pato",
   "picture": "https://joaquindecima.gitlab.io/img/profile.webp",
}

Salas

Permite gestionar las salas, las mismas se guardaran de forma local en la primera instancia de la aplicación si utilizacion de bbdd

POST /room/

Permite crear una sala

Body

{
   "roomName": "Vasak Room",
   "isPrivated": true,
   "password": "pass123",
}

201 Ok

{
   "roomId" : "uuid",
   "roomName": "Vasak Room",
   "isPrivated": true,
   "isSecure": true,
   "users": 5,
}

GET /room/

Permite obtener todas las salas publicas

200 Ok

{
   "roomId": "uuid",
   "roomName": "Vasak Room",
   "isPrivated": false,
   "isSecure": "pass123",
}