Documentation generator for RAML 1.0
Switch branches/tags
Clone or download

README.md

ramloα

Command line tool based on Node.js for generating RESTful API documentations written in RAML.

Manageable API - documentation generated by ramlo

Note

💥 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 4.4.5 LTS & 5.8.0 and RAML 0.8 (see Example section).

Instalation

npm install -g ramlo

Usage

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.

Example

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

Mock Service

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.

License

The MIT License (MIT)

Copyright (c) 2015 PGS Software

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.