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 Python package is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import petstore_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import petstore_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = petstore_api.FakeApi()
body = petstore_api.Client() # Client | client model

try:
    # To test \"client\" model
    api_response = api_instance.test_client_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FakeApi->test_client_model: %s\n" % e)

Documentation for API Endpoints

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

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

Documentation For Models

AdditionalPropertiesClass
Animal
AnimalFarm
ApiResponse
ArrayOfArrayOfNumberOnly
ArrayOfNumberOnly
ArrayTest
Capitalization
Cat
Category
ClassModel
Client
Dog
EnumArrays
EnumClass
EnumTest
FormatTest
HasOnlyReadOnly
List
MapTest
MixedPropertiesAndAdditionalPropertiesClass
Model200Response
ModelReturn
Name
NumberOnly
Order
OuterEnum
Pet
ReadOnlyFirst
SpecialModelName
Tag
User

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

Author

apiteam@swagger.io