Implementation of a RAML parser in Ruby (uses Psych YAML parser). It can also generate documentation, although this part might be extracted in the future.
This project is at very early stage, some parts might be missing or not working. Todo list is located below, if you want to contribute you can find me on RAML forums or just follow contribution guidelines.
Clone this repository:
git clone git@github.com:coub/raml_ruby.git
Require:
require 'lib/raml'
or
pry -r ./lib/raml.rb
To parse the file:
Raml.load_file("path/to/your/file.raml").parse
To generate Markdown documentation:
# write to file
Raml.document("/path/to/your/file.raml", "path/to/output/file.md")
# or just on screen
Raml.document("/path/to/your/file.raml")
###To Do: Parser
- Find the way to handle
!includetag properly - Resource types
- Resource traits
- Security schemes
- Publish to Rubygems
Documentation
- Cleaner layouts
- 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