# Getting Started with Swagger Petstore - OpenAPI 3.0
## Introduction
This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about
Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
You can now help us improve the API whether it's by making changes to the definition itself or to the code.
That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
_If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click [here](https://editor.swagger.io/?url=https://petstore.swagger.io/v2/swagger.yaml). Alternatively, you can load via the `Edit > Load Petstore OAS 2.0` menu option!_
Some useful links:
- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
Find out more about Swagger: [http://swagger.io](http://swagger.io)
## Install the Package
The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:
```python
pip install sdksio-swagger-petstore-3-sdk==1.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/sdksio-swagger-petstore-3-sdk/1.0.0
## Test the SDK
You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
```
pip install -r test-requirements.txt
pytest
```
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| `api_key` | `string` | |
The API client can be initialized as follows:
```python
from swaggerpetstoreopenapi30.swaggerpetstoreopenapi_30_client import Swaggerpetstoreopenapi30Client
from swaggerpetstoreopenapi30.configuration import Environment
client = Swaggerpetstoreopenapi30Client(
api_key='api_key',
environment=Environment.PRODUCTION
)
```
## Authorization
This API uses `Custom Header Signature`.
## List of APIs
* [Pet](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/pet.md)
* [Store](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/store.md)
* [User](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/user.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "sdksio-swagger-petstore-3-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "OpenAPI,swagger,apimatic,petstore",
"author": "",
"author_email": "developer-sdksio <developer+sdksio@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/ea/79/6e471e4b32783cba79d156682bf61281ea1103dc7384988ce5495a9c554a/sdksio-swagger-petstore-3-sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Swagger Petstore - OpenAPI 3.0\n\n## Introduction\n\nThis is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\n_If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click [here](https://editor.swagger.io/?url=https://petstore.swagger.io/v2/swagger.yaml). Alternatively, you can load via the `Edit > Load Petstore OAS 2.0` menu option!_\n\nSome useful links:\n\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)\n\nFind out more about Swagger: [http://swagger.io](http://swagger.io)\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install sdksio-swagger-petstore-3-sdk==1.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/sdksio-swagger-petstore-3-sdk/1.0.0\n\n## Test the SDK\n\nYou can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:\n\nNavigate to the root directory of the SDK and run the following commands\n\n```\npip install -r test-requirements.txt\npytest\n```\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `api_key` | `string` | |\n\nThe API client can be initialized as follows:\n\n```python\nfrom swaggerpetstoreopenapi30.swaggerpetstoreopenapi_30_client import Swaggerpetstoreopenapi30Client\nfrom swaggerpetstoreopenapi30.configuration import Environment\n\nclient = Swaggerpetstoreopenapi30Client(\n api_key='api_key',\n environment=Environment.PRODUCTION\n)\n```\n\n## Authorization\n\nThis API uses `Custom Header Signature`.\n\n## List of APIs\n\n* [Pet](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/pet.md)\n* [Store](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/store.md)\n* [User](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/controllers/user.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/swagger-petstore-3-0-python-sdk/tree/1.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Swagger Petstore - OpenAPI 3.0",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://apimaticpetstore.pages.dev/#/python/pet-store-api"
},
"split_keywords": [
"openapi",
"swagger",
"apimatic",
"petstore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a365ccf71bbb94ed3bca7d81f5c1acc772ac588bc87edfee5688f8b8572d5b3",
"md5": "87f2ddba6d72a5ab42fe9e87b4e4a971",
"sha256": "dfbd72398f6fdf2920f924241f121c6a1a0241d1145f9e290f5c4b4f6e325341"
},
"downloads": -1,
"filename": "sdksio_swagger_petstore_3_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87f2ddba6d72a5ab42fe9e87b4e4a971",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 30317,
"upload_time": "2023-06-07T13:20:41",
"upload_time_iso_8601": "2023-06-07T13:20:41.035715Z",
"url": "https://files.pythonhosted.org/packages/4a/36/5ccf71bbb94ed3bca7d81f5c1acc772ac588bc87edfee5688f8b8572d5b3/sdksio_swagger_petstore_3_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea796e471e4b32783cba79d156682bf61281ea1103dc7384988ce5495a9c554a",
"md5": "41a527e1f0dfddb2c696396cf3eba9f7",
"sha256": "168af81519b206747de55ae214a33671bd1b355f422f7b3fac342f6023a85ddf"
},
"downloads": -1,
"filename": "sdksio-swagger-petstore-3-sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "41a527e1f0dfddb2c696396cf3eba9f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14869,
"upload_time": "2023-06-07T13:20:42",
"upload_time_iso_8601": "2023-06-07T13:20:42.475776Z",
"url": "https://files.pythonhosted.org/packages/ea/79/6e471e4b32783cba79d156682bf61281ea1103dc7384988ce5495a9c554a/sdksio-swagger-petstore-3-sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-07 13:20:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sdksio-swagger-petstore-3-sdk"
}
JSON