https://github.com/mulesoft-labs/raml-client-generator

Template-driven generator of clients for APIs described by a RAML spec
https://github.com/mulesoft-labs/raml-client-generator

raml raml-codegen raml-tooling

Last synced: about 1 month ago
JSON representation

Template-driven generator of clients for APIs described by a RAML spec

• Host: GitHub
• URL: https://github.com/mulesoft-labs/raml-client-generator
• Owner: mulesoft-labs
• License: other
• Archived: true
• Created: 2014-08-15T06:17:14.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-11-29T02:57:29.000Z (about 1 year ago)
• Last Synced: 2024-04-13T03:44:13.434Z (8 months ago)
• Topics: raml, raml-codegen, raml-tooling
• Language: JavaScript
• Homepage:
• Size: 482 KB
• Stars: 121
• Watchers: 331
• Forks: 27
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-rest - raml-client-generator - Generates static client libs for js. (Clients / JavaScript Clients)

README

        
# RAML Client Generator

[![NPM version][npm-image]][npm-url]

[![NPM downloads][downloads-image]][downloads-url]

[![Build status][travis-image]][travis-url]

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

## Installation

First, make sure [node](http://nodejs.org) 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](https://github.com/mulesoft-labs/raml-javascript-generator) (`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](IMPLEMENTATION.md).

## Testing

```sh

npm install

npm test # This *will* test every language.

```

## License

Apache 2.0

[npm-image]: https://img.shields.io/npm/v/raml-client-generator.svg?style=flat

[npm-url]: https://npmjs.org/package/raml-client-generator

[downloads-image]: https://img.shields.io/npm/dm/raml-client-generator.svg?style=flat

[downloads-url]: https://npmjs.org/package/raml-client-generator

[travis-image]: https://img.shields.io/travis/mulesoft/raml-client-generator.svg?style=flat

[travis-url]: https://travis-ci.org/mulesoft/raml-client-generator