OpenAPI 3 Parser

Build Status

This is a parser/validator for Open API 3 built in Ruby.

Example usage:

require "openapi3_parser"

document = Openapi3Parser.load_file("path/to/example.yaml")

# check whether document is valid

# traverse document

Documentation for the API to navigate the OpenAPI nodes is available on


You can install this gem into your bundler application by adding this line to your Gemfile:

gem "openapi3_parser", "~> 0.2.0"

and then running $ bundle install

Or install the gem onto your machine via $ gem install openapi3_parser


This is currently a work in progress and will remain so until it reaches 1.0.

See TODO for details of the roadmap there.


MIT License