openapi-generator/samples/client/petstore/ruby

petstore

Petstore - the Ruby gem for the Swagger Petstore

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2016-05-11T16:13:11.464+08:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build petstore.gemspec

Then either install the gem locally:

gem install ./petstore-1.0.0.gem

(for development, run gem install --dev ./petstore-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'petstore', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'petstore', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

number = 3.4 # Float | None

double = 1.2 # Float | None

string = "string_example" # String | None

byte = "B" # String | None

opts = { 
  integer: 56, # Integer | None
  int32: 56, # Integer | None
  int64: 789, # Integer | None
  float: 3.4, # Float | None
  binary: "B", # String | None
  date: Date.parse("2013-10-20"), # Date | None
  date_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | None
  password: "password_example" # String | None
}

begin
  #Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
  api_instance.test_endpoint_parameters(number, double, string, byte, opts)
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->test_endpoint_parameters: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
Petstore::FakeApi	test_endpoint_parameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Petstore::PetApi	add_pet	POST /pet	Add a new pet to the store
Petstore::PetApi	delete_pet	DELETE /pet/{petId}	Deletes a pet
Petstore::PetApi	find_pets_by_status	GET /pet/findByStatus	Finds Pets by status
Petstore::PetApi	find_pets_by_tags	GET /pet/findByTags	Finds Pets by tags
Petstore::PetApi	get_pet_by_id	GET /pet/{petId}	Find pet by ID
Petstore::PetApi	update_pet	PUT /pet	Update an existing pet
Petstore::PetApi	update_pet_with_form	POST /pet/{petId}	Updates a pet in the store with form data
Petstore::PetApi	upload_file	POST /pet/{petId}/uploadImage	uploads an image
Petstore::StoreApi	delete_order	DELETE /store/order/{orderId}	Delete purchase order by ID
Petstore::StoreApi	get_inventory	GET /store/inventory	Returns pet inventories by status
Petstore::StoreApi	get_order_by_id	GET /store/order/{orderId}	Find purchase order by ID
Petstore::StoreApi	place_order	POST /store/order	Place an order for a pet
Petstore::UserApi	create_user	POST /user	Create user
Petstore::UserApi	create_users_with_array_input	POST /user/createWithArray	Creates list of users with given input array
Petstore::UserApi	create_users_with_list_input	POST /user/createWithList	Creates list of users with given input array
Petstore::UserApi	delete_user	DELETE /user/{username}	Delete user
Petstore::UserApi	get_user_by_name	GET /user/{username}	Get user by user name
Petstore::UserApi	login_user	GET /user/login	Logs user into the system
Petstore::UserApi	logout_user	GET /user/logout	Logs out current logged in user session
Petstore::UserApi	update_user	PUT /user/{username}	Updated user

Documentation for Models

• Petstore::Animal
• Petstore::AnimalFarm
• Petstore::ApiResponse
• Petstore::Cat
• Petstore::Category
• Petstore::Dog
• Petstore::EnumClass
• Petstore::EnumTest
• Petstore::FormatTest
• Petstore::Model200Response
• Petstore::ModelReturn
• Petstore::Name
• Petstore::Order
• Petstore::Pet
• Petstore::SpecialModelName
• Petstore::Tag
• Petstore::User

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets