JoseVte / tfg-recetarium

Recetario: Tus recetas siempre contigo

API Recetarium

RUTAS DE LA API

Recetas

Acción	URI	Login
Listado y busqueda por páginas	GET /recipes(?page=&size=&search=&order=&tags=)	---
Obtener por slug	GET /recipes/{slug}	---
Crear	POST /recipes	OWNER
Crear borrador	POST /recipes/draft	OWNER
Crear receta desde el borrador	POST /recipes/create-from-draft	OWNER
Actualizar	PUT /recipes/{id} PATCH /recipes/{id}	OWNER / ADMIN
Borrar	DELETE /recipes/{id}	OWNER / ADMIN
Comprobar slug	HEAD /recipes/{slug}/check HEAD /recipes/{slug}/check/{id}	COMUN
Comprobar propietario	HEAD /recipes/{slug}/mine	COMUN
Añadir un ingrediente	POST /recipes/{id-receta}/ingredient	OWNER / ADMIN
Borrar un ingrediente	DELETE /recipes/{id-receta}/ingredient/{id}	OWNER / ADMIN
Añadir/Borrar a favoritos	PUT /recipes/{id}/fav	COMUN
Puntuar la receta	PUT /recipes/{id}/rating	COMUN

Comentarios

Acción	URI	Login
Todas las respuestas	GET /recipes{recipe-id}/comments/{comentario-id}	---
Crear	POST /recipes{id}/comments POST /recipes{recipe-id}/comments/{comentario-id}	COMUN
Actualizar	PUT /recipes{recipe-id}/comments/{comentario-id} PATCH /recipes{recipe-id}/comments/{comentario-id}	OWNER / ADMIN
Borrar	DELETE /recipes{recipe-id}/comments/{comentario-id}	OWNER / ADMIN

Categorias

Acción	URI	Login
Todas las categorias	GET /categories	---
Todas las categorias con paginacion	GET /categories(?page=&size=&search=&order=)	---
Obtener por id	GET /categories/{id}	---
Crear	POST /categories	ADMIN
Actualizar	PUT /categories/{id} PATCH /categories/{id}	ADMIN
Borrar	DELETE /categories/{id}	ADMIN
Borrar multiple	DELETE /categories?ids=&ids=	ADMIN

Tags

Acción	URI	Login
Buscar tags	GET /tags(?search=)	---
Obtener por id	GET /tags/{id}	---

Autentificación

Acción	URI	Login
Loguear un usuario	POST /auth/login	---
Registrar un usuario	POST /auth/register	---
Enviar email para reiniciar la password	POST /auth/reset/password	---
Cambia la password	PUT /auth/reset/password PATCH /auth/reset/password	---
Comprobar el token	POST /auth/check	---
Activar cuenta	PUT /auth/active PATCH /auth/active	---
Obtener los detalles del perfil	GET /auth/profile	COMUN
Guardar los cambios del perfil	PUT /auth/profile PATCH /auth/profile	COMUN

Usuarios

Acción	URI	Login
Listado por páginas	GET /users(?page=&size=&search=&order=)	COMUN
Obtener por id	GET /users/{id}	COMUN
Crear	POST /users	ADMIN
Actualizar	PUT /users/{id} PATCH /users/{id}	ADMIN
Borrar	DELETE /users/{id}	ADMIN

Amigos

Acción	URI	Login
Listado por páginas	GET /users/{id}/friends(?page=&size=&search=&order=)	COMUN
Crear	POST /users/{id}/friends	COMUN
Borrar	DELETE /users/{user-id}/friends/{amigo-id}	COMUN

Archivos

Acción	URI	Login
Todas las imagenes	GET /users/{user-id}/files	COMUN
Obtener por nombre del archivo	GET /users/{user-id}/files/{id} GET /users/{user-id}/files/{nombre}	---
Subida del archivo	POST /users/{user-id}/files	OWNER / ADMIN
Borrar archivo	DELETE /users/{user-id}/files/{id} DELETE /users/{user-id}/files/{nombre}	OWNER / ADMIN

---

DOCUMENTACIÓN EXTENDIDA

• Autentificación
• Recetas
• Comentarios
• Usuarios
• Archivos
• Categorias
• Tags

---

CHANGELOG

1.0.0

• Primera release de la aplicación

0.13.1

• Comprobar el parametro order en la paginación
• Arreglado problema con el autoincremento de las recetas del usuario

0.12.3

• CRUD de las categorias

0.12.2

• Nueva ruta: obtener tag por ID

0.12.1

• Añadido idioma al perfil del usuario

0.11.3

• Creados los mensajes en español e ingles para la internacionalización

0.11.2

• Añadido pusher para las notificaciones

0.11.1

• Ver las recetas favoritas en el perfil

0.10.3-hotfix

• Arreglos en los Serializer

0.10.3

• Validacion del email durante el registro
• Añadido avatar al usuario
• Recreacion del JWT

0.10.2

• Busqueda de usuarios

0.10.1-hotfix

• Arreglo de errores y nuevos test añadidos

0.10.1

• Rutas para ver, agregar y borrar amigos

0.9.1

• Ver las recetas por usuario

0.8.2-hotfix

• Fixeada query para la busqueda de recetas por tags

0.8.2

• Busqueda de recetas por tags

0.8.1

• CRUD de comentarios

0.8.0-hotfix

• Ordenar recetas por fecha
• Nuevo sistema para contar las recetas

0.7.1

• Añadida galeria para elegir imagenes en la receta y el perfil de usuario

0.6.1

• Añadidas rutas para añadir a favoritos
• Añadida posibilidad de puntuar una receta del 0 al 5

0.5.2

• Nuevas rutas para el perfil
• Cambiados algunos metodos del UserService

0.5.1

• Generar borrador de una receta

0.5.0-hotfix-2

• Arreglado problema con la visibilidad de las recetas

0.5.0-hotfix

• Arreglado login cuando se ha enviado un correo para restaurar la password

0.5.0

• Añadida visibilidad a las recetas

0.4.1

• Busqueda de recetas
• Actualizada la documentación
• Añadidos nuevos test

0.4.0

• Gestion de ficheros con dropbox
• Cambio del servidor CI a Travis
• Añadidas las URL en los mails
• Cambios en la estructura del modelo de la receta
• Fix en el JWT y añadido token sin expiración
• Subida de múltiples archivos

0.3.4

• Subida, lectura y borrado de archivos en el servidor.

0.3.3

• Nuevos formatos de JSON para el input y output de los usuarios y recetas.

0.3.2-hotfix

• Nombre de los test fixeado en Jenkins

0.3.2

• Añadidos los middleware para evitar el acceso a zonas privadas.
• Versionado de la API con tag en el README.
• Test para los middleware.
• Nombre de los test fixeado en Linux (testear en Jenkins).

0.3.1-hotfix

• Hotfix: Añadido el filtro CORS para poder acceder desde la APP web.

0.3.1

• Despliegue de la aplicación en Heroku: recetarium

0.3.0

• Nuevo README.
• Implementación de registro,login y reinicio de password en un nuevo controller.
• Acceso a rutas privadas mediante JWT.
• Test para el nuevo controller

0.2.2

• Controller para las recetas.
• Test para el nuevo controllador.

0.2.1

• Cambiado el nombre del modelo Section por Category.
• Refactorización de los controllers, DAO y Models.
• Personalizacón de la salida de los test en el terminal.
• Refactorización de los test y clarificación de los nombres de los test.

0.2.0

• Añadidos todos los modelos básicos y sus relaciones:
  • User
  • Recipe
  • Comment
  • Media
  • Tag
  • Section
• Clases DAO y Service para los modelos.
• CRUD y servicios para usuarios, recetas, comentarios, categorias, tags y archivos.
• Automatización de los campos created_at y updated_at para los modelos.
• Creados los controllers básicos para usuarios y recetas.
• Creados los test para las clases DAO y Service usando un fichero YAML.

0.1.0

• Integración con Jenkins

0.0.0

• App base