Command line tool based on Node.js for generating RESTful API documentations written in RAML.
💥 ramlo is currently under development and uses RAML 1.0 JS Parser (beta), it is not finished yet and might be unstable.
It supports both RAML 0.8 and 1.0.
First tests performed on Node.js 5.8.0 and RAML 0.8 (see Example section).
npm install -g ramlo
ramlo -f api.raml
The output of this command is a HTML file called api.html
which should have RESTful API documentation generated based on provided RAML file.
If you do not have any API documented in RAML you can look at my other project called Manageably.
For testing please use API described in file manageably-0.8.raml
.
More examples: https://github.com/raml-apis
When you have API defined and documentation generated, you can run mock service. I recommend Osprey Mock Service. It generates an API mock service from a RAML definition using Osprey.
npm install -g osprey-mock-service
Start the service from the CLI. This will automatically use the baseUri
as the path to the mock service. For example, http://example.com/api
will result in http://localhost:{PORT}/api
.
osprey-mock-service -f api.raml -p 8000
💥 Unfortunately Osprey Mock Service does not support RAML 1.0, only RAML 0.8.
MIT