mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-07 19:08:52 +00:00
160 lines
6.7 KiB
Markdown
160 lines
6.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 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
|
|
|
|
body = Petstore::Client.new # Client | client model
|
|
|
|
|
|
begin
|
|
#To test \"client\" model
|
|
result = api_instance.test_client_model(body)
|
|
p result
|
|
rescue Petstore::ApiError => e
|
|
puts "Exception when calling FakeApi->test_client_model: #{e}"
|
|
end
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*Petstore::FakeApi* | [**test_client_model**](docs/FakeApi.md#test_client_model) | **PATCH** /fake | To test \"client\" model
|
|
*Petstore::FakeApi* | [**test_endpoint_parameters**](docs/FakeApi.md#test_endpoint_parameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
|
|
*Petstore::FakeApi* | [**test_enum_parameters**](docs/FakeApi.md#test_enum_parameters) | **GET** /fake | To test enum parameters
|
|
*Petstore::PetApi* | [**add_pet**](docs/PetApi.md#add_pet) | **POST** /pet | Add a new pet to the store
|
|
*Petstore::PetApi* | [**delete_pet**](docs/PetApi.md#delete_pet) | **DELETE** /pet/{petId} | Deletes a pet
|
|
*Petstore::PetApi* | [**find_pets_by_status**](docs/PetApi.md#find_pets_by_status) | **GET** /pet/findByStatus | Finds Pets by status
|
|
*Petstore::PetApi* | [**find_pets_by_tags**](docs/PetApi.md#find_pets_by_tags) | **GET** /pet/findByTags | Finds Pets by tags
|
|
*Petstore::PetApi* | [**get_pet_by_id**](docs/PetApi.md#get_pet_by_id) | **GET** /pet/{petId} | Find pet by ID
|
|
*Petstore::PetApi* | [**update_pet**](docs/PetApi.md#update_pet) | **PUT** /pet | Update an existing pet
|
|
*Petstore::PetApi* | [**update_pet_with_form**](docs/PetApi.md#update_pet_with_form) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
|
*Petstore::PetApi* | [**upload_file**](docs/PetApi.md#upload_file) | **POST** /pet/{petId}/uploadImage | uploads an image
|
|
*Petstore::StoreApi* | [**delete_order**](docs/StoreApi.md#delete_order) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
*Petstore::StoreApi* | [**get_inventory**](docs/StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status
|
|
*Petstore::StoreApi* | [**get_order_by_id**](docs/StoreApi.md#get_order_by_id) | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
*Petstore::StoreApi* | [**place_order**](docs/StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
|
|
*Petstore::UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create user
|
|
*Petstore::UserApi* | [**create_users_with_array_input**](docs/UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
|
|
*Petstore::UserApi* | [**create_users_with_list_input**](docs/UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array
|
|
*Petstore::UserApi* | [**delete_user**](docs/UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
|
|
*Petstore::UserApi* | [**get_user_by_name**](docs/UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
|
|
*Petstore::UserApi* | [**login_user**](docs/UserApi.md#login_user) | **GET** /user/login | Logs user into the system
|
|
*Petstore::UserApi* | [**logout_user**](docs/UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session
|
|
*Petstore::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/{username} | Updated user
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [Petstore::AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md)
|
|
- [Petstore::Animal](docs/Animal.md)
|
|
- [Petstore::AnimalFarm](docs/AnimalFarm.md)
|
|
- [Petstore::ApiResponse](docs/ApiResponse.md)
|
|
- [Petstore::ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md)
|
|
- [Petstore::ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md)
|
|
- [Petstore::ArrayTest](docs/ArrayTest.md)
|
|
- [Petstore::Cat](docs/Cat.md)
|
|
- [Petstore::Category](docs/Category.md)
|
|
- [Petstore::ClassModel](docs/ClassModel.md)
|
|
- [Petstore::Client](docs/Client.md)
|
|
- [Petstore::Dog](docs/Dog.md)
|
|
- [Petstore::EnumArrays](docs/EnumArrays.md)
|
|
- [Petstore::EnumClass](docs/EnumClass.md)
|
|
- [Petstore::EnumTest](docs/EnumTest.md)
|
|
- [Petstore::FormatTest](docs/FormatTest.md)
|
|
- [Petstore::HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
|
- [Petstore::List](docs/List.md)
|
|
- [Petstore::MapTest](docs/MapTest.md)
|
|
- [Petstore::MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
|
|
- [Petstore::Model200Response](docs/Model200Response.md)
|
|
- [Petstore::ModelReturn](docs/ModelReturn.md)
|
|
- [Petstore::Name](docs/Name.md)
|
|
- [Petstore::NumberOnly](docs/NumberOnly.md)
|
|
- [Petstore::Order](docs/Order.md)
|
|
- [Petstore::OuterEnum](docs/OuterEnum.md)
|
|
- [Petstore::Pet](docs/Pet.md)
|
|
- [Petstore::ReadOnlyFirst](docs/ReadOnlyFirst.md)
|
|
- [Petstore::SpecialModelName](docs/SpecialModelName.md)
|
|
- [Petstore::Tag](docs/Tag.md)
|
|
- [Petstore::User](docs/User.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
### api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key
|
|
- **Location**: HTTP header
|
|
|
|
### http_basic_test
|
|
|
|
- **Type**: HTTP basic authentication
|
|
|
|
### 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
|
|
|