aiopenapi3

If you can’t make it perfect, make it adjustable.

aiopenapi3 is a client library to interface RESTful services using OpenAPI/Swagger description documents, built upon pydantic for data validation/coercion and httpx for transport. It’s located on github.

Features & Limitations

While aiopenapi3 supports some of the more exotic features of the Swagger/OpenAPI specification, e.g.:

• multilingual

  • Swagger 2.0

  • OpenAPI 3.0

  • OpenAPI 3.1

• multi file description documents

• recursive schemas

• additionalProperties

• Discriminator/Polymorphism

• plugin interface to mangle description documents and messages

• Parameter Encoding

• Forms

some aspects of the specifications can not be supported.

• Schema Composition

  • oneOf - validation does not care if more than one matches

  • anyOf - implemented as oneOf

  • allOf - merging Schemas is limited wrt. to merge conflicts

• additionalProperties mixed with properties

• non-unique parameter names in an operations headers/path/query

Contents:

• Installation
• Using aiopenapi3
  • As a client
  • async
  • Command line
• Advanced usage
  • Authentication
  • Forms
  • Manual Requests
  • Session Factory
  • Logging
  • Loader
  • Serialization
  • Cloning
• Plugins
  • Init
  • Document
  • Message
• API
  • General
  • Requests
  • Parameters
  • Plugin Interface
  • Loader
  • Exceptions