express-raml-store

fork of arthurtsang/raml-store, that is a fork of brianmc/raml-store.
Is an Express module serving the awesome work of mulesoft/api-designer

Instead of saving to mongodb, it saves to the filesystem directly, exportes an handy Express 4 Router that you can mount on your desired endpoint

what

This package is meant to be mounted on your express server when in development mode, allowing to edit the API specification on-the-fly and ALSO test it (if your development server handles the API)

Example:

var app = require('express');
var ramlStore = require('express-raml-store');

// webpages
app.get('/', serveMyHomePage);
app.get('/admin/', greatAdminPanel);

// REST API
app.get('/api/', apiHandler);

if (process.env.NODE_ENV !== 'production') {
  app.use('/api-docs/', ramlStore(path.join(__dirname, 'raml-dir/')));
}

// continue until...
app.listen(3000)

how to use

Just include the module and specify the directory where you desire to host RAML files.

var path = require('path');
var express = require('express');
var ramlStore = require('express-raml-store');
var app = express();

app.use('/raml-store', ramlStore(path.join(__dirname, 'raml-dir/')));
var server = app.listen(3000, function () {
  console.log('Open http://localhost:%d/raml-store/ to browse api-designer', server.address().port);
});

express-raml-store also works as stand-alone:

$ RAML_DATAPATH=api-spec/raml/ node raml-store.js

TODO(s)

I noticed that path traversing is not my best skill, as you see in the example I give up and suggest to use path.join(__dirname, '<ramlPath>') I think this is a good approach, but I'd rather make the library a little more clever on path solving.
PR are very welcome!

Contributors

Changelog

1.2.1 (2015-10-25)

now supports both npm (2.x) and npm@next or npm@3, the 3.x branch default with nodejs 5.x

1.2.0 (2015-08-18)

**using api-designer package from npm

1.1.2 (2015-07-08)

bluebird dependency added

Bluebird Dependency #4

1.1.0 (2015-05-31)

Node.js is now supported

Node.js support #3

arcesino / express-raml-store Goto Github PK