https://github.com/ruby-grape/grape-swagger-entity

https://github.com/ruby-grape/grape-swagger-entity

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ruby-grape/grape-swagger-entity
• Owner: ruby-grape
• License: mit
• Created: 2016-05-07T22:57:50.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-05-09T23:24:51.000Z (9 months ago)
• Last Synced: 2025-05-14T08:53:47.478Z (9 months ago)
• Language: Ruby
• Size: 192 KB
• Stars: 44
• Watchers: 6
• Forks: 42
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# GrapeSwagger::Entity

[![Gem Version](https://badge.fury.io/rb/grape-swagger-entity.svg)](https://badge.fury.io/rb/grape-swagger-entity)

[![Build Status](https://github.com/ruby-grape/grape-swagger-entity/actions/workflows/test.yml/badge.svg)](https://github.com/ruby-grape/grape-swagger-entity/actions/workflows/test.yml)

## Table of Contents

- [What is grape-swagger-entity?](#what-is-grape-swagger-entity)

- [Installation](#installation)

- [Development](#development)

- [Contributing](#contributing)

- [License](#license)

## What is grape-swagger-entity?

A simple grape-swagger adapter to allow parse representers as response model

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'grape-swagger-entity'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install grape-swagger-entity

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/pry` 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/ruby-grape/grape-swagger-entity.

## License

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