json-patch-api
v0.1.3
Published
Provides an express middleware for a JSON store that supports real-time client updates using JSON-patch and mongojs as a backend for persistence.
Downloads
8
Readme
json-patch-api
Provides an express middleware for a JSON store that supports real-time client updates using JSON-patch"
Installation
This module is installed via npm:
$ npm install json-patch-api
Basic Usage
var jsonPatchApi = require('json-patch-api');
var app = express();
var io = require('socket.io')(server);
app.use('/api', require('json-patch-api')(io));
Middleware Routes
PUT /api/NAME
Stores whatever application/json payload you send it and replaces the current document and returns JSON-PATCH commands that are needed to update the document.
GET /api/NAME
Returns the current JSON document stored at the api endpoint. And a header X-Last-Patched
with the epoch time at which the last patch was applied.
GET /api/NAME/patches?after=TIMESTAMP
Returns a JSON struct which represents a sequence of JSON-PATCH operations which, if repeated sequentially would yield the current state of the document given a snapshot from time TIMESTAMP.
POST /api/NAME/patches
With a JSON-Patch payload will apply the patch to the current endpoint's state and broadcast it to all listening clients.
Clients
See http://www.github.com/allain/json-patch-api-client)