openapi-generator/samples/client/petstore/ruby/README.md

Installation

Build a gem

You can build the generated client into a gem:

gem build swagger_client.gemspec

Then you can either install the gem:

gem install ./swagger_client-1.0.0.gem

or publish the gem to a gem server like RubyGems.

Finally add this to your Gemfile:

gem 'swagger_client', '~> 1.0.0'

Host as a git repository

You can also choose to host the generated client as a git repository, e.g. on github: https://github.com/xhh/swagger-petstore-ruby

Then you can reference it in Gemfile:

gem 'swagger_client', :git => 'https://github.com/xhh/swagger-petstore-ruby.git'

Use without installation

You can also use the client directly like this:

ruby -Ilib script.rb

Configuration

require 'swagger_client'

SwaggerClient::Swagger.configure do |config|
  config.api_key['api_key'] = 'special-key'
  config.host = 'petstore.swagger.io'
  config.base_path = '/v2'
  # enable debugging (default is false)
  config.debug = true
end

Getting Started

pet = SwaggerClient::PetApi.get_pet_by_id(5)
puts pet.to_body