https://github.com/talentplatforms/ropen_pi

Rspec and OpenAPI Integration
https://github.com/talentplatforms/ropen_pi

openapi3 rspec rswag ruby swagger

Last synced: about 1 month ago
JSON representation

Rspec and OpenAPI Integration

• Host: GitHub
• URL: https://github.com/talentplatforms/ropen_pi
• Owner: talentplatforms
• License: mit
• Created: 2020-01-07T13:55:14.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T02:06:57.000Z (over 1 year ago)
• Last Synced: 2024-09-27T12:01:35.214Z (about 2 months ago)
• Topics: openapi3, rspec, rswag, ruby, swagger
• Language: Ruby
• Size: 315 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

# RopenPi

This is a fork of the [open-api-rswag gem](https://github.com/jdanielian/open-api-rswag).

It's a good gem in an early development stage. The original [rswag](https://github.com/rswag/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:

```ruby

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](https://code.visualstudio.com/docs/remote/containers).

## 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](https://opensource.org/licenses/MIT).