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.0a3.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.0a3-py3-none-any.whl (88.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiopenapi3-0.8.0a3.tar.gz
Algorithm Hash digest
SHA256 6d227cf0b6c0fd9482e24216e1a4d8b90df7a208a76df51c41e40f29a3ad44c9
MD5 64860d008452bb17b952151ebdac3a89
BLAKE2b-256 18bdfaf60fc8a4b01f28047d4daf0bac49a60325a2884e56ac02f4ccb2a3cd8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aiopenapi3-0.8.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 62cbb2c9d6956c63c5c2bd3460396970a3611cec5aef3c5ba1f0e697d5833673
MD5 e5955e06fce351af08fac21e7e3bff3d
BLAKE2b-256 c7fdac179b71579fe639b4583cc50bd6be5726f2bbb60d9fb5d3bb4dbd20f7d9

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