orchestra-webapi-ckws v0.0.3

orchestra-webapi

orchestra-webapi is an adapter for orchestra-jsapi. It leverages web technologies as REST and WebSockets to forward its functionality via HTTP.

Feature set

There is no active development on orchestra-webapi happening currently. Please do not expect to get the latest feature set of orchestra-jsapi adapted by orchestra-webapi.

Usage

The orchestra-webapi module is a pluggable Express application. In addition, it provides a WebSocket server using Primus. Following code demonstrates how you can attach orchestra-webapi to an Express instance.

var app = require('express')();
var webapi = require('./index.js');
app.use('/api', webapi.restApi); // attach REST routes
var server = app.listen(8080); // Start the HTTP server
var primus = webapi.webSocketApi(server); // attach WebSocket server