Graphiti::OpenAPI

OpenAPI 3.0 specification for your (Graphiti) JSON:API

Installation

Add this line to your Rails application's Gemfile:

gem 'graphiti-openapi'

And then execute:

bundle

Set up environment running

bin/rails graphiti:openapi:install

Configure OpenAPI template in config/openapi.yml and Graphiti::OpenAPI will pick your resources schema and translate it to OpenAPI 3.0 JSON and YAML files, providing Swagger UI with live API documentation.

Usage

Edit template in config/openapi.yml to customize your OpenAPI output. This file will be used as base for resulting document.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alsemyonov/graphiti-openapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Graphiti::OpenAPI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.