Bravado

Warnings

• deprecated The `HttpFuture.result()` method is deprecated. Users should now use `HttpFuture.response().result` to access the unmarshalled Swagger result, or `HttpFuture.response()` to get the full `BravadoResponse` instance which includes both the result and HTTP metadata.
  Fix: Replace `client.operation().result()` with `client.operation().response().result`.
• gotcha Bravado performs strict validation by default on the Swagger/OpenAPI specification itself, as well as on outgoing requests and incoming responses. This can lead to validation errors if the spec is malformed or if requests/responses don't strictly adhere to the schema.
  Fix: Ensure your Swagger spec is valid and that your API interactions conform to it. Validation can be selectively disabled via the `config` dictionary passed to `SwaggerClient.from_url()` or `from_spec()` (e.g., `{'validate_requests': False, 'validate_responses': False, 'validate_swagger_spec': False}`).
• gotcha Docstrings for operations in Bravado do not behave like standard Python function docstrings and the built-in `help()` function might not work as expected. The docstrings are structured more like class docstrings.
  Fix: When using an interactive Python environment (like IPython), use the `?` suffix (e.g., `client.pet.getPetById?`) to view the operation's detailed documentation, including parameters and return types.
• gotcha By default, network or server errors will raise exceptions (e.g., `BravadoTimeoutError`, `HTTPServerError`). For more graceful error handling, `HttpFuture.response()` supports a `fallback_result` argument.
  Fix: Pass a `fallback_result` (either a static value or a callable that accepts the exception) and optionally `exceptions_to_catch` to `response()`: `client.operation().response(fallback_result=my_fallback_func, exceptions_to_catch=(BravadoTimeoutError,))`.

Install

• pip install bravado Standard Install
• pip install bravado[fido] Install with Fido (Async) Client
• pip install bravado-asyncio Install with Asyncio Client

Imports

• SwaggerClient

  from bravado.client import SwaggerClient

• RequestsClient

  from bravado.requests_client import RequestsClient

• FidoClient

  from bravado.fido_client import FidoClient

• AsyncioClient

  from bravado_asyncio.http_client import AsyncioClient

  For the bravado-asyncio optional dependency.

Quickstart

Initializes a SwaggerClient from a public OpenAPI/Swagger specification URL and demonstrates a simple GET request. It also shows how to perform a POST request and mentions optional configuration to disable validation or receive responses as dictionaries instead of dynamic models.

from bravado.client import SwaggerClient

# Using a publicly available Petstore Swagger/OpenAPI spec
client = SwaggerClient.from_url('http://petstore.swagger.io/v2/swagger.json')

# Make a synchronous API call and get the result
try:
    # Using .response().result is the recommended way to get the data
    pet = client.pet.getPetById(petId=42).response().result
    print(f"Found pet: {pet.name} (ID: {pet.id})")

    # Example of a POST call
    Pet = client.get_model('Pet')
    Category = client.get_model('Category')
    new_pet = Pet(id=100, name="Buddy", category=Category(id=1, name="Dogs"), photoUrls=[])
    add_result = client.pet.addPet(body=new_pet).response().result
    print(f"Added pet: {add_result.name} (ID: {add_result.id})")

except Exception as e:
    print(f"An error occurred: {e}")

# Example of disabling validation for a request/response (not recommended for production)
# client_config = {
#     'validate_requests': False,
#     'validate_responses': False,
#     'use_models': False # Get dicts instead of dynamic models
# }
# client_relaxed = SwaggerClient.from_url(
#     'http://petstore.swagger.io/v2/swagger.json', 
#     config=client_config
# )
# pet_dict = client_relaxed.pet.getPetById(petId=42).response().result
# print(f"Found pet as dict: {pet_dict.get('name')}")