Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skryukov/openapi_validator

OpenApi v3 validator
https://github.com/skryukov/openapi_validator

Last synced: 5 days ago
JSON representation

OpenApi v3 validator

Awesome Lists containing this project

README

        

[gem]: https://rubygems.org/gems/openapi_validator
[travis]: https://travis-ci.org/medsolutions/openapi_validator
[codeclimate]: https://codeclimate.com/github/medsolutions/openapi_validator

# openapi_validator
[![Gem Version](https://badge.fury.io/rb/openapi_validator.svg)][gem]
[![Build Status](https://travis-ci.org/medsolutions/openapi_validator.svg?branch=master)][travis]
[![Code Climate](https://codeclimate.com/github/medsolutions/openapi_validator/badges/gpa.svg)][codeclimate]
[![Test Coverage](https://codeclimate.com/github/medsolutions/openapi_validator/badges/coverage.svg)][codeclimate]
[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)

Validator used for [openapi_rspec](https://github.com/medsolutions/openapi_rspec)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'openapi_validator'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install openapi_validator

## Usage

See rspec for examples.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/medsolutions/openapi_validator.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

This project includes the [OpenAPI 3.0 Schema](https://github.com/googleapis/gnostic/blob/master/OpenAPIv3/openapi-3.0.json) as `data/openapi-3.0.json`. Copyright 2017, Google Inc. Released under the Apache 2.0 license.