Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.39 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.39 KB

carouselApi

Rest API for carousel-service with NodeJS

version: 1.0.0

Installation

npm install

Development

Run application server and start development

npm run serve

Environment

localhost:8080

API Guide

Endpoints list

localhost:8080/apiDocs
Method Path Payload Description
GET /status - Check application status
GET /carousels/:department - Get carousels list from department
POST /carousel key: carousel key,
name: carousel name,
department: department key
Add new carousel
DELETE /carousel key: carousel key,
department: department key
Remove carousel from department
GET /departments - Get departments list
POST /department key: department key,
name: department name
Add new department
DELETE /department key: department key Remove department
GET /offers/:department/:carousel - Get offers
GET /offer/:id - Get offer details
POST /offer/:id department: department key,
carousel: carousel key
Add new offer to carousel
DELETE /offer/:id department: department key,
carousel: carousel key
Remove offer from carousel

License

Released under the ISC License