commit | 29a951431edbfb5425093a2860dc2899dcf83673 | [log] [tgz] |
---|---|---|
author | Peter K. Lee <peter@intercloud.net> | Sat Aug 13 03:25:18 2016 -0700 |
committer | Peter K. Lee <peter@intercloud.net> | Sat Aug 13 03:25:18 2016 -0700 |
tree | 12c355ab3db38203974eaa61be4d3a084003d826 | |
parent | 13e63a7b75fc0368bfb4f95ede9e9233b09ba507 [diff] |
major update to latest yang-js/yang-express to now support hot-pluggable data models during runtime. also enable complete event-propagation for changes to the data models on a per-model basis. fixes #2 and #3. documentation updated to reflect initial support for openapi/swagger 2.0 specification auto-generation. near-complete support for websocket/socket.io will enable dynamic change push to the client application
This is a work-in-progress effort to create YANG data models for the CORD project and deliver flexible service compositions.
You may contact Larry Peterson llp@onlab.us and Peter Lee peter@corenova.com to learn more about this initiative and find out how you can help.
$ npm install yang-cord
Following the installation, you can start an instance of the YANG model-driven REST API web server. It utilizes yang-express middleware framework built on Express.js to provide dynamic YANG model-driven API routing capability.
$ npm start > yang-cord@1.0.8 start /home/plee/hack/yang-cord > node lib/api/server.js [yang-express] start of a new journey [openapi] enabling... [openapi] enabled ok [restjson] enabling... [restjson] enabled ok [websocket] enabling... [yang-express] registering a new link [yang-express] registered 'link:cord-core' [yang-express] registering a new link [yang-express] registered 'link:xos-core' [websocket] binding to server [websocket] enabled ok
An option --port
is provided to specify the port to listen on, it can be used with:
npm start -- --port 3000
To run the test suite, first install the dependencies, then run npm test
.
$ npm install $ npm test
Mocha test suite is currently under development...