Skip to content

Latest commit

 

History

History
119 lines (83 loc) · 4.27 KB

README.md

File metadata and controls

119 lines (83 loc) · 4.27 KB

openapi_client

OpenapiClient - the Ruby gem for the WizardWorldApi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-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 'openapi_client', '~> 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 'openapi_client', :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 'openapi_client'

api_instance = OpenapiClient::ElixirsApi.new
opts = {
  name: 'name_example', # String | 
  difficulty: OpenapiClient::ElixirDifficulty::UNKNOWN, # ElixirDifficulty | 
  ingredient: 'ingredient_example', # String | 
  inventor_full_name: 'inventor_full_name_example', # String | 
  manufacturer: 'manufacturer_example' # String | 
}

begin
  result = api_instance.elixirs_get(opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ElixirsApi->elixirs_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://wizard-world-api.herokuapp.com

Class Method HTTP request Description
OpenapiClient::ElixirsApi elixirs_get GET /Elixirs
OpenapiClient::ElixirsApi elixirs_id_get GET /Elixirs/{id}
OpenapiClient::FeedbackApi feedback_post POST /Feedback
OpenapiClient::HousesApi houses_get GET /Houses
OpenapiClient::HousesApi houses_id_get GET /Houses/{id}
OpenapiClient::IngredientsApi ingredients_get GET /Ingredients
OpenapiClient::IngredientsApi ingredients_id_get GET /Ingredients/{id}
OpenapiClient::SpellsApi spells_get GET /Spells
OpenapiClient::SpellsApi spells_id_get GET /Spells/{id}
OpenapiClient::WizardsApi wizards_get GET /Wizards
OpenapiClient::WizardsApi wizards_id_get GET /Wizards/{id}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.