WORK IN PROGRESS

RAML JavaScript Generator

Generate a JavaScript API client from RAML. Expose defined "schemas" as Typescript interfaces resp. types.

Installation

npm install raml-javascript-generator -g

Usage

This module depends on raml-generator and can be used globally or locally with JavaScript.

• Chained DSL generation
• README.md output
• Support for client.methodName and client.displayName annotations
• Emits OAuth 2.0 client wrappers

Global

raml-javascript-generator api.raml -o js-client

Locally

var jsGenerator = require('raml-javascript-generator')

var output = jsGenerator(/* api, data */)

Limitations

• Used schema generator does not (yet) support $ref external references
• Only explicitly named schemas are exposed via type or interface

License

Apache License 2.0