Pydantic OpenAPI Generator

Documentation: here

Migration from auth-broker

As of pydantic-openapi-generator version 2.2.8, this package has moved out of the auth-broker organisation, been renamed, and had its import namespace updated.

The old PyPI package is retained as an archived historical package. New work should use pydantic-openapi-generator and pydantic_openapi_generator.

Features

• Ease of use. Provide input, output and the library, and the generator will do the rest.
• Type safety and type hinting. Pydantic OpenAPI Generator makes heavy use of pydantic models to provide type-safe data structures.
• Support for multiple rest frameworks. Pydantic OpenAPI Generator currently supports the following:
  • httpx
  • requests
  • aiohttp
• Async and sync code generation support, depending on the framework. It will automatically create both for frameworks that support both.
• Easily extendable using Jinja2 templates. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
• Fully tested. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.
• Usage as CLI or as library.

Requirements

• Python 3.12+

Installation

You can install Pydantic OpenAPI Generator via pip from PyPI:

$ pip install pydantic-openapi-generator

Usage

Please see the Quick start page for details.

HTTP client configuration

Generated httpx clients default to a 30 second timeout. You can override that and enable an httpx-retries policy from the generator configuration file:

default_timeout: 30.0
retry:
  total: 3
  backoff_factor: 0.5
  status_forcelist:
    - 429
    - 502
    - 503
    - 504

When retry is configured, the generated client project must include httpx-retries. Retry settings use the same Pydantic RetryFactory model in the generator configuration and the generated package's utils/retry.py.

Clients also accept retry settings directly from JSON:

client = AsyncClient.model_validate_json('{"timeout": 30.0, "retry": {"total": 3, "backoff_factor": 0.5}}')

RetryFactory.get_retry() constructs the httpx-retries policy, and get_transport() constructs its transport. Set retry to null to disable retries.

Roadmap

• Support for all commonly used http libraries in the python ecosystem (requests, urllib, ...)
• Support for multiple languages
• Support for multiple authentication schemes
• Support custom themes

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Openapi Python Generator is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

Special thanks to the peeps from openapi-schema-pydantic, which already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.