offline-todo-api

Simple (hopefully) RESTful API that allows you to create, read, ~~update~~ and delete items from your todo list.

Note: PUT is not supported as todos are intentionally not updateable in this version.

Install and run

Quick start:

npm install -g offline-todo-api
offline-todo-api

Full development build:

git clone [email protected]:matthew-andrews/offline-todo-api.git
cd offline-todo-api
npm install
node index.js

Documentation

GET /todos - list all todos

curl https://offline-todo-api.herokuapp.com/todos

GET /todos/:id - read a specific todo

curl https://offline-todo-api.herokuapp.com/todos/1408228141678

POST /todos - create a new todo

curl https://offline-todo-api.herokuapp.com/todos -X POST -d '{"text":"Do the dishes"}' -H "Content-Type: application/json"

Input

Name | Type | Description ------- | --------- | ------------------------------------ text | string | Required. The todo text id | mixed | Required. Some unique identifier

DELETE /todos/:id - delete a todo

curl https://offline-todo-api.herokuapp.com/todos/1408228141678 -X DELETE

Note: once an item has been deleted a todo its id cannot be reused.

GET /todos/stream

Can be used as a event source that will stream an updated message whenever a todo is created or deleted.