Project

ropen_pi

0.0
Low commit activity in last 3 years
No release in over a year
Integrates OpenAPI v3 with RSPEC and automates the output of the open api document
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
~> 13.0
~> 6.1.7
~> 3.10
= 0.44.2

Runtime

 Project Readme

Conventional Commits

RopenPi

This is a fork of the open-api-rswag gem. It's a good gem in an early development stage. The original rswag gem and the open api fork a have one thing in common: they do to much.

There are easier ways to get an instance of the swagger ui running than building it as a rails engine.

In future releases this gem will provide a basic example of how this will look like.

In the mean time this will remain a WIP :)

Installation

Add this line to your application's Gemfile:

gem 'ropen_pi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ropen_pi

Unsupported

Due to massive changes in the spec, this gem currently does not support any type of collection queries.

Usage

TODO: Write usage instructions here

Development

So you have decided to contribute?! This sounds great! To make it super easy to start the only thing you have to have installed is Docker. Then you can just use the batteries-included DevContainer for VSCode.

There is a lot of documentation on getting started with this kind of development. If you are kind of new to this please make sure to read the offical docs over at Microsoft.

Contributing

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

License

The gem is available as open source under the terms of the MIT License.