- Liptak, Franco Emanuel
- Onofri, Camila Ayelén
- Raimondi, Sebastián
La API está alojada en Heroku: https://dssd-coupons.herokuapp.com/
Al igual que en la primer entrega, el grupo eligió trabajar con Express (intraestructura de aplicaciones web Node.js). El framework fue elegido por la facilidad que provee al programador para crear APIs sólidas, de manera rápida y sencilla. En esa oportunidad se eligió trabajar con Node.js por su popularidad, rendimiento, flexibilidad de desarrollo, entre otras ventajas. Todas esas ventajas provocaron que decidamos volver a usar la tecnología para esta segunda entrega.
La base de datos utilizada es PostgreSQL, ya que decidimos deployar nuestra API en Heroku (Heroku solo ofrece PostgreSQL como motor de bases de datos gratuito).
Elegimos Heroku como servicio para exponer nuestra API por su facilidad de uso y buen rendimiento. Además, el grupo ya tenía experiencia usándolo.
GET /api/v1.0/coupons - Lista todos los cupones.
- Ejemplo de uso:
curl http://dssd-coupons.herokuapp.com/api/v1.0/coupons
También es posible pasar dos parámetros:
-
Parámetro filter, arreglo que en su interior posee todos los criterios de filtro (json). Cada criterio debe indicar field(campo a analizar) operator(operador a usar) y value(valor que se busca).
-
Parámetro pagination, json que en su interior indica limit(límite) y puede indicar o no offset(a partir de cual producto se empiezan a devolver productos).
-
Ejemplo de uso:
curl http://dssd-coupons.herokuapp.com/api/v1.0/coupons?filter=[{"field":"used","operator":"=","value":0}]
curl http://dssd-coupons.herokuapp.com/api/v1.0/coupons?pagination={"offset":0,"limit":2}
curl http://dssd-coupons.herokuapp.com/api/v1.0/coupons?pagination={"offset":0,"limit":2}&filter=[{"field":"used","operator":"=","value":1}]
GET /api/v1.0/coupons/:id - Devuelve el cupón que se indica por el parámetro numérico id.
- Ejemplo de uso:
curl http://dssd-coupons.herokuapp.com/api/v1.0/coupons/1
POST /api/v1.0/coupons - Permite la creación de un cupón. Es necesario pasarle el parámetro 'number', el cual simboliza el número de cupón, y también 'discount_percentage'.
- Ejemplo de uso:
curl -X POST --data "number=123&discount_percentage=20" http://dssd-coupons.herokuapp.com/api/v1.0/coupons
PUT /api/v1.0/coupons/:id - Permite actualizar un cupón. Los campos que se permiten modificar son 'number', 'discount_percentage' y 'used', el cual indica si el cupón fue utilizado o no.
- Ejemplo de uso:
curl -X PUT --data "number=1234&used=B"1"&discount_percentage=5" http://dssd-coupons.herokuapp.com/api/v1.0/coupons/2
DELETE /api/v1.0/coupons/:id - Permite eliminar un cupón. Vale aclarar que se utiliza borrado lógico.
- Ejemplo de uso:
curl -X DELETE http:/dssd-coupons.herokuapp.com/api/v1.0/coupons/3