Skip to main content

A library for generating web API clients from OpenAPI documents

Project description

oapi

test PyPI version

oapi is a library for authoring python client libraries for web APIs based on an OpenAPI specification (both OpenAPI/Swagger version 2 and version 3 are supported).

oapi-generated packages/modules differ from those generated by other tools (including but not limited to swagger-codegen) in that oapi generates a data model which enforces the schemas defined in the OpenAPI specification. This means that request and response objects, and their properties/items/members, cannot comprise data types which differ from those specified in their OpenAPI document. Additionally, request and response objects can be validated using sob.validate to verify that they were not parsed from an object having attributes not defined in the element's JSON schema, and have all required attributes. oapi fully supports polymorphism when a schema has an "anyOf", "allOf", or "oneOf" attribute (although oapi does not require a discriminator to be defined).

Notable features of an oapi generated client/model library include:

  • oapi generated data models and clients are fully type-annotated
  • oapi generated data models and clients adhere to PEP-8 formatting
  • oapi generated data models and clients include docstrings for all models, model properties, client methods, and client method parameters, inferred from "description" and "summary" attributes of elements within the specification
  • oapi generated clients will handle the most common server-to-server authentication methods out-of-box, including the OAuth2 authorization code flow (client_id/client_secret), API keys, bearer tokens, HTTP basic auth, and most cookie-based authentication patterns. Custom authentication methods are also easily accomplished by specifying custom base classes and/or passing initialization decorators to oapi.write_client_module.
  • oapi generated clients and models are easily updated. For instance: oapi generated data model classes can be renamed using your favorite IDE's refactoring tools, and subsequent updates to that data model (such as to reflect minor-version updates to the spec which add endpoints, schemas, parameters, etc.) will retain your new class names, so long as the schema from which the class was generated remains in the same location within the spec. Class naming can also be customized by passing a custom hook to the get_class_name_from_pointer parameter for oapi.write_model_module.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

oapi-2.2.3.tar.gz (64.9 kB view details)

Uploaded Source

Built Distribution

oapi-2.2.3-py3-none-any.whl (69.1 kB view details)

Uploaded Python 3

File details

Details for the file oapi-2.2.3.tar.gz.

File metadata

  • Download URL: oapi-2.2.3.tar.gz
  • Upload date:
  • Size: 64.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for oapi-2.2.3.tar.gz
Algorithm Hash digest
SHA256 29af894496890a0ce9e5e89996276dee3c7c18c32cf8385189a155840e2850d9
MD5 f9c4b673532d1314000faa21cfe92343
BLAKE2b-256 46b055b7b5b4ad2f66f8b138e6679847924c380193cc727755268fa3e87d43fb

See more details on using hashes here.

File details

Details for the file oapi-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: oapi-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 69.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for oapi-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9dfff5cb43f31d45de3299a18b6cbe6558100724e1093b18165757fb870161bd
MD5 090b5586fb2e50535bd2e8e558851a2a
BLAKE2b-256 92b3b08e17285d17e0cc1412cf11a442d564690e3ec979d980939528060393f7

See more details on using hashes here.

Supported by

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