valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-07 19:08:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
9e45a99e60
openapi-generator/samples/client/petstore/ruby/README.md
wing328 9e45a99e60 udpate ruby api doc
2016-03-19 11:09:49 +08:00

7.0 KiB
Raw Blame History

petstore

Petstore - the Ruby gem for the Swagger Petstore

This is a sample server Petstore server. You can find out more about Swagger at <a href="http://swagger.io">http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters

This SDK is automatically generated by the Swagger Codegen project:

  • API verion: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-03-18T17:42:42.943+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

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 a git repository: https://github.com/YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID

Then add the following in the Gemfile:

gem 'petstore', :git => 'https://github.com/YOUR_GIT_USR_ID/YOUR_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'

# Setup authorization
Petstore.configure do |config|
  # Configure OAuth2 access token for authorization: petstore_auth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = Petstore::PetApi.new

opts = { 
  body: Petstore::Pet.new # Pet | Pet object that needs to be added to the store
}

begin
  #Add a new pet to the store
  api_instance.add_pet(opts)
rescue Petstore::ApiError => e
  puts "Exception when calling PetApi->add_pet: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
Petstore::PetApi add_pet POST /pet Add a new pet to the store
Petstore::PetApi add_pet_using_byte_array POST /pet?testing_byte_array=true Fake endpoint to test byte array in body parameter for adding 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 get_pet_by_id_in_object GET /pet/{petId}?response=inline_arbitrary_object Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
Petstore::PetApi pet_pet_idtesting_byte_arraytrue_get GET /pet/{petId}?testing_byte_array=true Fake endpoint to test byte array return by '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 find_orders_by_status GET /store/findByStatus Finds orders by status
Petstore::StoreApi get_inventory GET /store/inventory Returns pet inventories by status
Petstore::StoreApi get_inventory_in_object GET /store/inventory?response=arbitrary_object Fake endpoint to test arbitrary object return by 'Get inventory'
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

Documentation for Authorization

test_api_key_header

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

api_key

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

test_http_basic

  • Type: HTTP basic authentication

test_api_client_secret

  • Type: API key
  • API key parameter name: x-test_api_client_secret
  • Location: HTTP header

test_api_client_id

  • Type: API key
  • API key parameter name: x-test_api_client_id
  • Location: HTTP header

test_api_key_query

  • Type: API key
  • API key parameter name: test_api_key_query
  • Location: URL query string

petstore_auth