Skip to main content

aiopenapi3

A Python OpenAPI 3 Specification client and validator for Python 3.

Test pre-commit.ci status Coverage Supported Python versions Documentation Status

This project is a fork of Dorthu/openapi3.

Features

  • implements …
    • Swagger 2.0
    • OpenAPI 3.0.3
    • OpenAPI 3.1.0
    • OpenAPI 3.2.0
  • description document parsing via pydantic
    • recursive schemas (A.a -> A)
  • request body model creation via pydantic
    • pydantic compatible "format"-type coercion (e.g. datetime.interval)
    • additionalProperties (string-to-any dictionaries, including inline schemas with allOf/nullable)
  • response body & header parsing via pydantic
  • blocking and nonblocking (asyncio) interface via httpx2
    • SOCKS5 via socksio
  • tests with pytest & fastapi
  • providing access to methods and arguments via the sad smiley ._. interface
  • Plugin Interface/api to modify description documents/requests/responses to adapt to non-compliant services
  • YAML type coercion hints for not well-formatted description documents
  • Description Document dependency downloads (using the WebLoader)
    • logging
      • export AIOPENAPI3_LOGGING_HANDLERS=debug to get /tmp/aiopenapi3-debug.log

Documentation

API Documentation

Running Tests

This project includes a test suite, run via pytest. To run the test suite, ensure that you've installed the dependencies and then run pytest in the root of this project.

PYTHONPATH=. pytest --cov=./ --cov-report=xml .

Metadata

Release files for aiopenapi3 0.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiopenapi3 0.11.0
File Size Uploaded
aiopenapi3-0.11.0.tar.gz 79.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiopenapi3 0.11.0
File Interpreter ABI Platform
aiopenapi3-0.11.0-py3-none-any.whl Python 3 none any Details

Total release size: 183.7 kB

Release files / aiopenapi3-0.11.0.tar.gz

Download URL aiopenapi3-0.11.0.tar.gz
Size 79.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0fec5a1de01aa842d60d3fe4297f13261a026736264653db586330ce7a632f05
BLAKE2b-256 checksum
How to use checksums
0f5613336586eef4774c95f11f604ab964bc78dd9d69a621695709f8e8e0a94f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / aiopenapi3-0.11.0-py3-none-any.whl

Download URL aiopenapi3-0.11.0-py3-none-any.whl
Size 104.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ba262120d4358d0a90ae081d27d7509600b908a412948ee74832aa0e81aa16b
BLAKE2b-256 checksum
How to use checksums
7e1c7cd07dfb640bf2a537baf05cb4f3c770854e8d2ee0f2d9033cf8fc4fbd14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page