Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.17 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.17 KB

RAML Object To RAML

NPM version Build status Test coverage

Takes a RAML object in JavaScript and emits properly-formatted RAML (text).

Installation

npm install raml-object-to-raml --save

Usage

CLI

Supports piping in JSON and printing the resulting RAML to stdout.

cat api.json | raml-object-to-raml > api.raml

JavaScript

The module can be required inside other projects for generating the RAML file directly from JavaScript objects.

var toRAML = require('raml-object-to-raml');

console.log(toRAML({ ... }));
// #%RAML 0.8
// title: Example API
// ...

License

Apache 2.0