A handy command-line tool for RAML enthusiasts.
- validate - Validates a root RAML document against the specification.
- compile - Compiles a root RAML document into a valid OpenAPI 2.0 document.
- init - Initialize a basic RAML document based on user input.
- mock - Mocks a root RAML document.
$ npm install -g raml-cli
Usage: raml <command>
Commands:
compile <file> [options] Compiles a root RAML document into a valid OpenAPI 2.0
document.
init [options] Initialize a RAML document.
mock <file> [options] Mocks a root RAML document .
validate <file> Validates a root RAML document against the RAML
specification.
Options:
--help, -h Show help [boolean]
--version, -v Show version number [boolean]
For more information go to https://github.com/raml-org/raml-cli
The command can be used for validating the syntax of a RAML document as follows:
raml validate examples/simple.raml
if it succeds you see something like the following:
Validating examples/simple.raml...
Valid!
otherwise it will fail with a message containing an explanation on the error.
Compiles a root RAML document into a valid OpenAPI 2.0 document. It can be used as follows:
raml compile examples/simple.raml
if it succeds you see something like the following:
Compile examples/simple.raml...
Successfully compiled OAS 2.0 document.
otherwise it will fail with a message containing an explanation on the error.
-o, --output [value]
Type: String
Default: openapi.yml
Compiled OpenAPI 2.0 document file path.
Initialize a basic RAML document based on user input. It can be used as follows:
raml init
if it succeds you see something like the following:
init...
? What is the title of your API? (empty string is not allowed): <your title>
? How would you describe your API? (Enter to skip): <your description>
Initialization successful!
otherwise it will fail with a message containing an explanation on the error.
This command is using Handlebars under the hood to initialize the RAML document. The following properties are supported at the moment:
title(Title of your API and is equivalent to RAML's root nodetitle- required)description(Description of your API and is equivalent to RAML's root nodedescription- optional)
-t, --template [value]
Type: String
File path of a custom Handlebars template.
Mocks a root RAML document. It can be used as follows:
raml mock examples/simple.raml
if it succeds you see something like the following:
Mock service running at http://localhost:8080
otherwise it will fail with a message containing an explanation on the error.
-p, --port [value]
Type: String
Port number to bind the proxy. Default: 8080.
--cors [value]
Type: boolean
Enable CORS with the API. Default: false.