agulab / feriastore

API para manejo de items y ventas

Los HTTP status de las respuestas pueden ser 200, 201, 400, 404, 409 según corresponda. También 500 si el servidor encuentra un error inesperado.

/items

GET: retorna lista de items.

Parámetros opcionales:

• limit=int cantidad de resultados por página
• page=int número de la página requerida
• sort=string nombre de alguno de los atributos del item por el que ordenar
• asc para especificar un orden ascendente. Por defecto el orden es descendente

Ejemplos:

• /items?limit=10,page=1,sort=name,asc
• /items?limit=5,sort=id

POST: crea un nuevo item y lo retorna

Atributos obligatorios del body:

• name=string el nombre del item
• size=string el tamaño del item

Atributos opcionales del body:

• stock=int por defecto se crea con stock 0
• todo=int por defecto se crea con toDo 0
• img=string url de una imagen

PATCH: actualiza todos los items pasando sus 'todo' al 'stock'

/items/{id}

GET: retorna el item {id}

DELETE: elimina el item {id}

PATCH: modifica el item{id}

Atributos opcionales del body:

• todo=int nuevo valor para 'todo'
• stock=int nuevo valor para 'stock'
• img=string nueva url de 'img'

/items/{id}/toStock

PUT: suma al stock y resta de toDo

Atributos opcionales:

• n=int por defecto se suma y resta un elemento, pero con este parámetro puede especificarse una cantidad diferente

/sales

GET: retorna lista de ventas

Parámetros opcionales:

• limit=int cantidad de resultados por página
• page=int número de la página requerida
• sort=string nombre de alguno de los atributos de la venta por el que ordenar
• asc para especificar un orden ascendente. Por defecto el orden es descendente

Ejemplos:

• /sales?limit=10,page=1,sort=price,asc
• /sales?page=2,sort=date

POST: crea una nueva venta y la retorna

Atributos obligatorios del body:

• itemId=int el id del item que se vende
• price=int el precio del item que se vende
• date=string la fecha en formato "YYYY-MM-DD"

/sales/{id}

GET: retorna la venta {id}