openapi-schema-pydantic

What it is and what it does

openapi-schema-pydantic wraps the OpenAPI v3 specification as a set of Pydantic data classes, letting you build and validate OpenAPI documents programmatically in Python. Instead of hand-writing JSON or YAML specs, you instantiate Pydantic objects (OpenAPI, Info, Operation, Response, etc.) that follow the official schema naming and structure, then serialize them to spec-compliant JSON or dict.

The package leverages Pydantic's validation and schema generation to handle the complexity of OpenAPI's nested structure. It supports both object-oriented construction and mixed dict/object input, and includes utilities to embed Pydantic model schemas directly into OpenAPI documents as JSON Schema references. It offers both OpenAPI 3.1.0 and 3.0.3 versions via separate import paths.

Use it for

• Generate OpenAPI specs programmatically from Python code instead of maintaining separate YAML/JSON files.
• Validate OpenAPI documents at runtime using Pydantic's built-in validation before publishing or serving them.
• Embed Pydantic model schemas into OpenAPI definitions to keep request/response types in sync with your code.
• Build API documentation tooling that constructs OpenAPI specs from Python function signatures and type hints.
• Migrate or transform existing OpenAPI specs by parsing them into Pydantic objects, modifying them, and re-serializing.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

openapi-schema-pydantic on PyPI

Before you install

Low install friction with a single runtime dependency. Maintenance is dormant—last release was 2022-06-29, though the repository remains active and the package is widely used.

Requires Python >=3.6.1; when serializing to JSON, must use by_alias=True and exclude_none=True to comply with OpenAPI standard.

License in practice

MIT License (permissive). No restrictions on commercial or private use; you may modify and distribute freely with attribution.

Quickstart

pip install openapi-schema-pydantic

from openapi_schema_pydantic import OpenAPI, Info, Operation, Response

open_api = OpenAPI(
    info=Info(title="My API", version="v1"),
    paths={"/ping": {"get": Operation(responses={"200": Response(description="pong")})}}
)
print(open_api.json(by_alias=True, exclude_none=True))

Package facts

Evidence: openapi_schema_pydantic-1.2.4-py3-none-any.whl

Tags

More WWW/HTTP packages

See also openapi-pydantic · flask-pydantic-spec · aiopenapi3 · flask-openapi3 · turnkey-sdk-types · open-data-contract-standard · openapi-spec-validator · json-schema-to-pydantic · openapi-python-client · schemathesis