RAML ruby
Implementation of a RAML parser in Ruby. It uses the stdlib YAML parser (Psych). It can also generate HTML documentation.
Installation
Add this line to your application's Gemfile:
gem 'raml_ruby'
And then execute:
$ bundle
Or install it yourself as:
$ gem install raml_ruby
You can also clone the repository to build the latest master:
$ git clone git@github.com/coub/raml_ruby.git
Usage
Install the gem as shown above, then require:
require 'raml'
or
pry -r ./lib/raml.rb
To parse the file:
Raml.parse_file("path/to/your/file.raml")
To Do
- Align merging strategy of conflicting properties of resource types and traits with official Javascript and Java parsers.
- Security schemes
More a more detailed analysis of the spec requirements and which ones are finishes see the RAML requirements document.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
See LICENSE.