Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colthreepv/express-raml-store
Express 4 Router to serve mulesoft's api-designer, and save your work on filesystem
https://github.com/colthreepv/express-raml-store
Last synced: 10 days ago
JSON representation
Express 4 Router to serve mulesoft's api-designer, and save your work on filesystem
- Host: GitHub
- URL: https://github.com/colthreepv/express-raml-store
- Owner: colthreepv
- License: mit
- Created: 2015-02-22T13:58:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-07T16:45:18.000Z (over 7 years ago)
- Last Synced: 2024-10-13T12:02:51.704Z (25 days ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 27
- Watchers: 2
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# express-raml-store
fork of [arthurtsang/raml-store](https://github.com/arthurtsang/raml-store), that is a fork of [brianmc/raml-store](https://github.com/brianmc/raml-store).
Is an Express module serving the awesome work of [mulesoft](https://github.com/mulesoft)/[api-designer](https://github.com/mulesoft/api-designer)
Instead of saving to mongodb, it saves to the filesystem directly, exportes an handy [Express 4 Router](http://expressjs.com/guide/routing.html#express-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:
```javascript
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.
```javascript
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:
```shell
$ 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, '')`
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
* [colthreepv](https://github.com/colthreepv)
* [jmagnusson](https://github.com/jmagnusson)
* [arcesino](https://github.com/arcesino)
# Changelog
>## [1.2.2](https://github.com/colthreepv/express-raml-store/tree/1.2.2) (2016-08-14)
>
> * fix style and script serving #6
>## [1.2.1](https://github.com/colthreepv/express-raml-store/tree/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](https://github.com/colthreepv/express-raml-store/tree/1.2.0) (2015-08-18)
>
> **using `api-designer` package from npm
> ## [1.1.2](https://github.com/colthreepv/express-raml-store/tree/1.1.2) (2015-07-08)
>
> **bluebird dependency added**
>
> - Bluebird Dependency [\#4](https://github.com/colthreepv/express-raml-store/issues/4)
> ## [1.1.0](https://github.com/colthreepv/express-raml-store/tree/1.1.0) (2015-05-31)
>
> **Node.js is now supported**
>
> - Node.js support [\#3](https://github.com/colthreepv/express-raml-store/pull/3)