mulesoft-labs / raml-javascript-generator

Generate a JavaScript API client from RAML

RAML JavaScript Generator

Generate a JavaScript API client from RAML.

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 */)

Generated Client Logging

Generated clients support logging of requests performed. To activate the logging set the NODE_DEBUG environment variable to the name of the generated client.

The data for the request performed and the response received will be displayed in the output.

License

Apache License 2.0