It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- 🛠 Make your SDK feel handcrafted by customizing it
- ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
- 🎁 Publish your SDK to package managers by configuring automatic publishing
- ✨ When ready to productionize, delete this section from the README
pip install git+https://github.com/speakeasy-sdks/test-py-ryan.git
import swagger_petstore
from swagger_petstore.models import shared
s = swagger_petstore.SwaggerPetstore()
req = shared.Pet(
id=596804,
name='<value>',
)
res = s.pets.create_pets(req)
if res is not None:
# handle response
pass
- create_pets - Create a pet
- list_pets - List all pets
- show_pet_by_id - Info for a specific pet
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
import swagger_petstore
from swagger_petstore.models import errors, shared
s = swagger_petstore.SwaggerPetstore()
req = shared.Pet(
id=596804,
name='<value>',
)
res = None
try:
res = s.pets.create_pets(req)
except errors.SDKError as e:
# handle exception
raise(e)
if res is not None:
# handle response
pass
You can override the default server globally by passing a server index to the server_idx: int
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | http://petstore.swagger.io/v1 |
None |
import swagger_petstore
from swagger_petstore.models import shared
s = swagger_petstore.SwaggerPetstore(
server_idx=0,
)
req = shared.Pet(
id=596804,
name='<value>',
)
res = s.pets.create_pets(req)
if res is not None:
# handle response
pass
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
import swagger_petstore
from swagger_petstore.models import shared
s = swagger_petstore.SwaggerPetstore(
server_url="http://petstore.swagger.io/v1",
)
req = shared.Pet(
id=596804,
name='<value>',
)
res = s.pets.create_pets(req)
if res is not None:
# handle response
pass
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import swagger_petstore
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = swagger_petstore.SwaggerPetstore(client=http_client)
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!