Template-driven generator of clients for APIs described by a RAML spec
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
dist
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
IMPLEMENTATION.md
LICENSE
README.md
bower.json
package.json
raml-client-generator.js

README.md

RAML Client Generator

NPM version NPM downloads Build status

Template-driven generator of clients for APIs described by RAML.

Installation

First, make sure node has been installed. Then, we can install it using npm:

npm install raml-client-generator -g

Usage

To generate an API client, point the command to your base RAML file and specify the output directory and language.

raml-to-client api.raml -o api-client -l javascript

Supported Languages

  • JavaScript (javascript)
    • Node and browser support
    • Promises
    • Complete OAuth 2.0 Support
    • Multiple client instances
    • Automatic README.md and package.json generation
    • Multi-part form data

We're excited to see new languages soon! If you have a language you'd like to implement, check out the implementation guide.

Testing

npm install
npm test # This *will* test every language.

License

Apache 2.0