aiopenapi3

0.10.0 verified Fri May 01 auth: no python

Async client and validator for OpenAPI 3.0, 3.1, 3.2, and Swagger 2.0 specifications. Current version 0.10.0, requires Python >=3.10. Active development with frequent releases.

pip install aiopenapi3

Common errors

error ModuleNotFoundError: No module named 'aiopenapi3' ↓

cause The package 'aiopenapi3' is not installed or install target is wrong.

fix

Run: pip install aiopenapi3

error AttributeError: module 'aiopenapi3' has no attribute 'load_file' ↓

cause load_file is not a top-level symbol in older versions (<0.9.0).

fix

Upgrade to aiopenapi3 >=0.9.0 or import from aiopenapi3.loaders.load_file.

error aiopenapi3.exceptions.APIError: 404 Not Found ↓

cause The API returned a non-2xx status, which now raises an exception by default since v0.8.0.

fix

Catch APIError or configure the client to suppress raising on errors.

Warnings

breaking In v0.8.0, the client now raises exceptions for HTTP error status codes (4xx, 5xx) instead of returning error responses. Code that previously checked response status must be updated. ↓

fix Wrap API calls in try/except or handle aiopenapi3.exceptions.APIError.

breaking In v0.6.0, model access changed: RootModel wrappers were removed, so model attributes are accessed directly without .root. ↓

fix Replace any model.root.attribute with model.attribute.

gotcha The library requires Python >=3.10. Installing on Python 3.9 or older will fail with a version incompatibility. ↓

fix Upgrade Python to 3.10+ or use aiopenapi3 <0.9.0 (though it may have fewer features/security updates).

deprecated Support for Python 3.9 was dropped in v0.9.0; Python 3.8 was dropped in v0.8.0. ↓

fix Use Python 3.10 or later.

Imports

OpenAPI
wrong
```
from openapi3 import OpenAPI
```
correct
```
from aiopenapi3 import OpenAPI
```
Correct package is 'aiopenapi3', not 'openapi3'.

load_file

wrong

from aiopenapi3.loaders import load_file

correct

from aiopenapi3 import load_file

load_file is exposed at top level since v0.9.0.

Quickstart

Load an OpenAPI spec and call an endpoint asynchronously.

import os
from aiopenapi3 import OpenAPI

# Load spec from URL
api = OpenAPI(
    url="https://petstore3.swagger.io/api/v3/openapi.json",
    auth=lambda r: r.with_headers({"api_key": os.environ.get("API_KEY", "")})
)

# Call an operation (e.g., list pets)
pets = api.list_pets(limit=10)
print(pets)