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 OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python >= 3.6
If the python package is hosted on a repository, you can install directly using:
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 openapi_clientInstall 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 openapi_clientPlease follow the installation procedure and then run the following:
import datetime
import time
import openapi_client
from pprint import pprint
from openapi_client.api import another_fake_api
from openapi_client.model.client import Client
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = another_fake_api.AnotherFakeApi(api_client)
client = Client(
client="client_example",
) # Client | client model
try:
# To test special tags
api_response = api_instance.call_123_test_special_tags(client)
pprint(api_response)
except openapi_client.ApiException as e:
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)All URIs are relative to http://petstore.swagger.io:80/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AnotherFakeApi | call_123_test_special_tags | PATCH /another-fake/dummy | To test special tags |
| DefaultApi | foo_get | GET /foo | |
| FakeApi | fake_health_get | GET /fake/health | Health check endpoint |
| FakeApi | fake_outer_boolean_serialize | POST /fake/outer/boolean | |
| FakeApi | fake_outer_composite_serialize | POST /fake/outer/composite | |
| FakeApi | fake_outer_number_serialize | POST /fake/outer/number | |
| FakeApi | fake_outer_string_serialize | POST /fake/outer/string | |
| FakeApi | test_body_with_file_schema | PUT /fake/body-with-file-schema | |
| FakeApi | test_body_with_query_params | PUT /fake/body-with-query-params | |
| 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 |
| FakeApi | test_group_parameters | DELETE /fake | Fake endpoint to test group parameters (optional) |
| FakeApi | test_inline_additional_properties | POST /fake/inline-additionalProperties | test inline additionalProperties |
| FakeApi | test_json_form_data | GET /fake/jsonFormData | test json serialization of form data |
| FakeApi | test_query_parameter_collection_format | PUT /fake/test-query-paramters | |
| 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 |
| PetApi | upload_file_with_required_file | POST /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
| StoreApi | delete_order | DELETE /store/order/{order_id} | Delete purchase order by ID |
| StoreApi | get_inventory | GET /store/inventory | Returns pet inventories by status |
| StoreApi | get_order_by_id | GET /store/order/{order_id} | 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 |
- AdditionalPropertiesClass
- Address
- Animal
- AnimalFarm
- ApiResponse
- Apple
- AppleReq
- ArrayOfArrayOfNumberOnly
- ArrayOfNumberOnly
- ArrayTest
- Banana
- BananaReq
- Capitalization
- Cat
- CatAllOf
- Category
- ClassModel
- Client
- Dog
- DogAllOf
- EnumArrays
- EnumClass
- EnumTest
- File
- FileSchemaTestClass
- Foo
- FormatTest
- Fruit
- FruitReq
- GmFruit
- HasOnlyReadOnly
- HealthCheckResult
- InlineResponseDefault
- List
- Mammal
- MapTest
- MixedPropertiesAndAdditionalPropertiesClass
- Model200Response
- ModelReturn
- Name
- NullableClass
- NumberOnly
- Order
- OuterComposite
- OuterEnum
- OuterEnumDefaultValue
- OuterEnumInteger
- OuterEnumIntegerDefaultValue
- Pet
- ReadOnlyFirst
- SpecialModelName
- StringBooleanMap
- Tag
- User
- Whale
- Zebra
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
- Type: API key
- API key parameter name: api_key_query
- Location: URL query string
- Type: Bearer authentication (JWT)
- Type: HTTP basic authentication
- Type: HTTP signature authentication
- 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
If the OpenAPI document is large, imports in openapi_client.apis and openapi_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from openapi_client.api.default_api import DefaultApifrom openapi_client.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import openapi_client
from openapi_client.apis import *
from openapi_client.models import *