lists-system v1.0.1

favLists

Author

Sagi Ajaj

Description

Create a fast out-of-the-box "Favorites lists". The lists you create can have the following properties:

• Categories
• Sub-items

Examplary use case: A user wants to create a couple of favorite movies lists, categorizing each as horror/action/drama etc... while a list can contain any number of movies as its items.

Installation

Use npm to install this package.

npm install --save lists-system

OR require as a dependency

{
    "dependencies": {
        "lists-system": "~1.0.0"
    }
}

API Specification

Let root be the base path to your app.

List API

• GET root/lists - fetch all lists
• GET root/lists/{id} - fetch a specific list
• POST root/lists | Use name & description parameters - store a list object
• POST root/lists/filter | Use categoryId parameter - filters lists by category id
• POST root/lists/{id} | use categoryId parameter - attaches a category to the current list
• UPDATE root/lists | Use id,name & description parameters - updates a list resource
• DELETE root/lists/{id} - deletes a list
• DELETE root/lists/{list_id}/{category_id} - detaches a category from a list

Items API

• Coming soon!

Categories API

• Coming soon as well!

Usage

Coming soon :)