Contents

# OpenAPI 3 Parser

[![Build Status](https://travis-ci.org/kevindew/openapi3_parser.svg?branch=master)](https://travis-ci.org/kevindew/openapi3_parser)


This is a parser/validator for [Open API 3][openapi-3] built in Ruby.

Example usage:

```
require "openapi3_parser"

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

# check whether document is valid
document.valid?

# traverse document
document.paths["/"]
```

Documentation for the API to navigate the OpenAPI nodes is available on
[rubydoc.info][docs].

[openapi-3]: https://github.com/OAI/OpenAPI-Specification
[docs]: http://www.rubydoc.info/github/kevindew/openapi3_parser/Openapi3Parser/Node/Openapi

## Installation

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

```
gem "openapi3_parser", "~> 0.5.0"
```

and then running `$ bundle install`

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

## Status

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

See [TODO](TODO.md) for details of the roadmap there.

## Licence

[MIT License](LICENCE)

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
openapi3_parser-0.5.2	README.md
openapi3_parser-0.5.1	README.md
openapi3_parser-0.5.0	README.md