loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/openapi3/client/petstore/python-aiohttp/README.md
VelorumS f082a35d2e
[Python] fix object arrays giving mypy error "Incompatible types in assignment" in to_dict() (#19223) 
* [python] mypy fix for multiple arrays of objects

* [python] mypy test for multiple arrays of objects
2024-07-29 16:34:27 +08:00

16 KiB
Raw Blame History

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
  • Generator version: 7.8.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import datetime
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# 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 = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)



# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.AnotherFakeApi(api_client)
    client = petstore_api.Client() # Client | client model

    try:
        # To test special tags
        api_response = await api_instance.call_123_test_special_tags(client)
        print("The response of AnotherFakeApi->call_123_test_special_tags:\n")
        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
DefaultApi foo_get GET /foo
FakeApi fake_any_type_request_body POST /fake/any_type_body test any type request body
FakeApi fake_enum_ref_query_parameter GET /fake/enum_ref_query_parameter test enum reference query parameter
FakeApi fake_health_get GET /fake/health Health check endpoint
FakeApi fake_http_signature_test GET /fake/http-signature-test test http signature authentication
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 fake_property_enum_integer_serialize POST /fake/property/enum-int
FakeApi fake_ref_enum_string GET /fake/ref_enum_string test ref to enum string
FakeApi fake_return_boolean GET /fake/return_boolean test returning boolean
FakeApi fake_return_byte_like_json GET /fake/return_byte_like_json test byte like json
FakeApi fake_return_enum GET /fake/return_enum test returning enum
FakeApi fake_return_enum_like_json GET /fake/return_enum_like_json test enum like json
FakeApi fake_return_float GET /fake/return_float test returning float
FakeApi fake_return_int GET /fake/return_int test returning int
FakeApi fake_return_list_of_objects GET /fake/return_list_of_object test returning list of objects
FakeApi fake_return_str_like_json GET /fake/return_str_like_json test str like json
FakeApi fake_return_string GET /fake/return_string test returning string
FakeApi fake_uuid_example GET /fake/uuid_example test uuid example
FakeApi test_additional_properties_reference POST /fake/additionalProperties-reference test referenced additionalProperties
FakeApi test_body_with_binary PUT /fake/body-with-binary
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_date_time_query_parameter PUT /fake/date-time-query-params
FakeApi test_empty_and_non_empty_responses POST /fake/empty_and_non_empty_responses test empty and non-empty responses
FakeApi test_endpoint_parameters POST /fake Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
FakeApi test_error_responses_with_model POST /fake/error_responses_with_model test error responses with model
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_inline_freeform_additional_properties POST /fake/inline-freeform-additionalProperties test inline free-form additionalProperties
FakeApi test_json_form_data GET /fake/jsonFormData test json serialization of form data
FakeApi test_object_for_multipart_requests POST /fake/object_for_multipart_requests
FakeApi test_query_parameter_collection_format PUT /fake/test-query-parameters
FakeApi test_string_map_reference POST /fake/stringMap-reference test referenced string map
FakeClassnameTags123Api test_classname PATCH /fake_classname_test To test class name in snake case
ImportTestDatetimeApi import_test_return_datetime GET /import_test/return_datetime test date time
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

Documentation For Authorization

Authentication schemes defined for the API:

petstore_auth

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

bearer_test

  • Type: Bearer authentication (JWT)

http_signature_test

  • Type: HTTP signature authentication

Author