How mike-oakley/openapi-pydantic works
Project type and purpose
• openapi-pydantic is an open-source Python library that provides type-safe OpenAPI 3.0 and 3.1 schema classes built on Pydantic.
• It’s not a web service or full-stack app, but a toolkit for constructing, parsing, and validating OpenAPI definitions in Python code.
File structure
• Top-level package: openapi_pydantic/
• compat.py – abstracts Pydantic 1 vs 2 compatibility
• util.py – helper functions (e.g. PydanticSchema, construct_open_api_with_schema_class)
• v3/ – version-independent logic, including a parser.py and common utilities
• v3/v3_0/ and v3/v3_1/ – subpackages defining Pydantic models for each OpenAPI version
• Config and metadata: pyproject.toml, .github/, .devcontainer/
• Scripts and tests: smokeshow.py (demo or quick test), tests/ covering parsing, schema validation, utility functions.
README for additional insights
• Public API:
• parse_obj() or OpenAPI.model_validate() entrypoints
• OpenAPI, PathItem, Operation, Response, plus versioned imports
• Features: support for both Pydantic v1 & v2, both OpenAPI 3.0.x and 3.1.1
• Emphasis on utility functions and best practices when serializing (aliases, exclude_none).
Essential elements
• Clear labels for each package and module
• Callouts for important classes (OpenAPI, PathItem, Operation) and helpers (PydanticSchema).