Skip to main content

client and validator for OpenAPI3 3.0, OpenAPI 3.1, Swagger 2.0

Project description

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
  • 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 (limited to string-to-any dictionaries without properties)
  • response body & header parsing via pydantic
  • blocking and nonblocking (asyncio) interface via httpx
    • SOCKS5 via httpx_socks
  • 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 .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiopenapi3-0.8.0.tar.gz (67.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiopenapi3-0.8.0-py3-none-any.whl (87.9 kB view details)

Uploaded Python 3

File details

Details for the file aiopenapi3-0.8.0.tar.gz.

File metadata

  • Download URL: aiopenapi3-0.8.0.tar.gz
  • Upload date:
  • Size: 67.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.5.27

File hashes

Hashes for aiopenapi3-0.8.0.tar.gz
Algorithm Hash digest
SHA256 5d4e1b358e501150832351a95eabd172c7b426d6db0e07cc0e93b22ca90d3dfa
MD5 74f9bbf2e8e1e4bf9841a346a3d2c0e7
BLAKE2b-256 f5cc11a114e581ef96d4af9f44f6a9de1247db7b69265d6fea2300dc92ac55fe

See more details on using hashes here.

File details

Details for the file aiopenapi3-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: aiopenapi3-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 87.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.5.27

File hashes

Hashes for aiopenapi3-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 159a5dcbffc6d69cb21c97dd1a1806c08e6b44743679ea515e0923048375d61a
MD5 8a90db289c21ced4d67d4915eff1b6b7
BLAKE2b-256 2610fda18338de0eaeba186526f3fdd918c69c125310e39c27667c36f99935b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page