Raml CLI Tools

CLI RAML and Swagger tools - generate flat RAML, generate swagger from RAML, generate swagger ui

Install

$ npm install -g raml-tools

Usage

$ raml-tools help

Flat

Generates flat RAML file from the given RAML file. If --save destination option is used, generated flat RAML file will be saved to the given destination, otherwise it will be printed to screen.

$ raml-tools flat file [--save destination]

Swagger

Generates swagger.json file from the given flat RAML file.

$ raml-tools swagger file [options]

Options:

• --save destination - Save flatten RAML into specified destination file.
• -c, --clear-server - Clears any servers defined in RAML, so the result will contain only those added with -s option
• -s, --server serverUrl - Additional server url(s). Can be repeated multiple times.
• -b, --base-uri defaultValue - Add server url as variable with the given value.

UI

Generates swagger ui in the given directory

$ raml-tools ui [options]

Options:

• -s, --source swaggerJsonFile - Swagger file to use in UI.
• -d, --destination dir - Destination directory where to generate swagger UI.
• -o, --open - Start http server and open generated swagger UI.

Http

Runs static http serevr on given directory

$ raml-tools http [options]

Options:

• -d, --destination dir - Directory to use as server root.
• -o, --open - Open browser automatically
• -p, --port - Port to run server on, defaults to 3000

Mock

Runs mock API serevr for the given flat RAML file

$ raml-tools mock [options]

Options:

• -f, --file ramlFile - Flat RAML file to mock.
• -p, --port - Port to run server on, defaults to 3001