Skip to content
This repository has been archived by the owner on Sep 20, 2021. It is now read-only.

Latest commit

 

History

History
19 lines (13 loc) · 935 Bytes

README.md

File metadata and controls

19 lines (13 loc) · 935 Bytes

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')()
	, webapi = require('orchestra-webapi');

app.use('/api', webapi.restApi);  // attach REST routes

webSocketApi(app.listen(8080));   // Start the HTTP server and attach WebScoket server to it