Project

raml_ruby

0.06
Repository is archived
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Implementation of RAML parser in Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 0.10
~> 10.0
~> 1.1
~> 3.0
~> 0.8

Runtime

 Project Readme

RAML ruby

Build Status

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

See LICENSE.