forked from loafle/openapi-generator-original
* Changes python-experimental types to classes, adds additionalalproperties handling Adds model_utils update, updates model.mustache Updates api.mustache and uses model_to_dict in model_normal.mustache Updates requirements.mustache for PythonClientExperimental Passes through check_type when deserializing models Converts types from strings to classes in PythonClientExperimentalCodegen.java and PythonTest.java Creates PythonClientExperimentalTest.java Updates toInstantiationType to use ModelUtils.xxx Corrects docstring descriptions of response_type Updates python-experimental typing, partially fixes deserialization tests Adds fixes for some of the deserialization tests Fixes deserialization tests Switches model teplates to use allVars so allof props will be included Fixes tests.test_enum_arrays Fixes test_to_str Adds additional_properties_type, fixes teast_todict in test_map_test.py Correctly check the type of _request_timeout values Fixes test_upload_file test Turns off coercion when instantiating model types with client data Updates file handling to input and output an open file object Fixes linting errors Adds fixes for python2 tests, linting fixes Adds additionalproperties to docs + tests Regenerates python-experimatal client * Regenerates python-experimental client * Updates windows python-experimental bat file * Fixes addModelImport so client generation will work with the v2 spec * Reverts PythonClientCodegen.java * Acutally revert PythonClientCodegen.java * Updates the sample example for file_type in docs * Silences line too long error for python models so CI tests pass * Fixes handling of file uploads, adds tests for uploading files * Removes comment * Fixes mock installation in python2 * Limit mock addition to python-experimental test requirements only * Removes SmartBear copyright line
petstore-api
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
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
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 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
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Create an instance of the API class
api_instance = petstore_api.AnotherFakeApi(petstore_api.ApiClient(configuration))
body = petstore_api.Client() # Client | client model
try:
# To test special tags
api_response = api_instance.call_123_test_special_tags(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)
Documentation for API Endpoints
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 |
FakeApi | create_xml_item | POST /fake/create_xml_item | creates an XmlItem |
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 |
Documentation For Models
- AdditionalPropertiesAnyType
- AdditionalPropertiesArray
- AdditionalPropertiesBoolean
- AdditionalPropertiesClass
- AdditionalPropertiesInteger
- AdditionalPropertiesNumber
- AdditionalPropertiesObject
- AdditionalPropertiesString
- Animal
- ApiResponse
- ArrayOfArrayOfNumberOnly
- ArrayOfNumberOnly
- ArrayTest
- Capitalization
- Cat
- CatAllOf
- Category
- ClassModel
- Client
- Dog
- DogAllOf
- EnumArrays
- EnumClass
- EnumTest
- File
- FileSchemaTestClass
- FormatTest
- HasOnlyReadOnly
- List
- MapTest
- MixedPropertiesAndAdditionalPropertiesClass
- Model200Response
- ModelReturn
- Name
- NumberOnly
- Order
- OuterComposite
- OuterEnum
- Pet
- ReadOnlyFirst
- SpecialModelName
- Tag
- TypeHolderDefault
- TypeHolderExample
- User
- XmlItem
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
api_key_query
- Type: API key
- API key parameter name: api_key_query
- Location: URL query string
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