forked from loafle/openapi-generator-original
105 lines
2.7 KiB
Markdown
105 lines
2.7 KiB
Markdown
# 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](https://github.com/swagger-api/swagger-codegen) project:
|
|
|
|
- API version: 1.0.0 */ ' \"
|
|
- Package version: 1.0.0
|
|
- Build date: 2016-06-28T17:34:19.923+08:00
|
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
|
|
|
## Installation
|
|
|
|
### Build a gem
|
|
|
|
To build the Ruby code into a gem:
|
|
|
|
```shell
|
|
gem build petstore.gemspec
|
|
```
|
|
|
|
Then either install the gem locally:
|
|
|
|
```shell
|
|
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](https://rubygems.org/).
|
|
|
|
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:
|
|
|
|
```shell
|
|
ruby -Ilib script.rb
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation](#installation) procedure and then run the following code:
|
|
```ruby
|
|
# Load the gem
|
|
require 'petstore'
|
|
|
|
api_instance = Petstore::FakeApi.new
|
|
|
|
opts = {
|
|
test_code_inject____end: "test_code_inject____end_example" # String | To test code injection */ ' \"
|
|
}
|
|
|
|
begin
|
|
#To test code injection */ ' \"
|
|
api_instance.test_code_inject____end(opts)
|
|
rescue Petstore::ApiError => e
|
|
puts "Exception when calling FakeApi->test_code_inject____end: #{e}"
|
|
end
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://petstore.swagger.io */ ' " =end/v2 */ ' " =end*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*Petstore::FakeApi* | [**test_code_inject____end**](docs/FakeApi.md#test_code_inject____end) | **PUT** /fake | To test code injection */ ' \"
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [Petstore::ModelReturn](docs/ModelReturn.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
### api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key */ ' " =end
|
|
- **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 */ ' " =end
|
|
- read:pets: read your pets */ ' " =end
|
|
|