4 Commits

Author SHA1 Message Date
bbd45cbf2d fix indentation on _resolve_spec_env_vars call in __init__ 2026-07-18 20:20:21 +05:30
0dc96907fa resolve {ENV_VAR} placeholders in spec before serving
- app.py: add _resolve_env and _resolve_spec_env_vars to replace
  {ENV_VAR} patterns (e.g. {AUTH_SERVER}) with os.environ values
  so the frontend receives resolved URLs via /openapi.json
2026-07-18 20:07:32 +05:30
cda158e549 build introspect URL from x-server-url + x-introspect-path
- security.py: read x-server-url and x-introspect-path separately
  from resolved security scheme, join to form introspect URL
2026-07-18 19:48:38 +05:30
a2169b2bb1 add spec-driven auth dependency injection
- security.py: parse securitySchemes, resolve {ENV_VAR} from env,
  generate FastAPI Depends for Bearer JWT introspection
- app.py: extract schemes, build deps, pass to binder at init
- binder.py: inject Depends() per operation based on spec's security
- __init__.py: export security module
- pyproject.toml: add httpx dependency
2026-07-17 21:00:23 +05:30
162 changed files with 2846 additions and 10151 deletions

View File

@@ -23,50 +23,20 @@ steps:
commands: commands:
- PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | head -1 | cut -d'"' -f2) - PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
- VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2) - VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
- echo "🔍 Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
- | - |
if [ "$DRONE_TAG" != "$VERSION" ]; then if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then
echo "Tag '$DRONE_TAG' does not match pyproject version '$VERSION'; refusing to publish." echo "✅ $PACKAGE_NAME==$VERSION already exists — skipping build."
exit 1
fi
- echo "Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
- |
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then
echo "$PACKAGE_NAME==$VERSION already exists; skipping build."
exit 78 exit 78
else else
echo "New version detected: $PACKAGE_NAME==$VERSION" echo "🆕 New version detected: $PACKAGE_NAME==$VERSION"
fi fi
- name: quality-gate
image: python:3.13-slim
environment:
PIP_REPO_URL:
from_secret: PIP_REPO_URL
PIP_USERNAME:
from_secret: PIP_USERNAME
PIP_PASSWORD:
from_secret: PIP_PASSWORD
commands:
- pip install --upgrade pip build
- |
if [ -z "$PIP_REPO_URL" ] || [ -z "$PIP_USERNAME" ] || [ -z "$PIP_PASSWORD" ]; then
echo "PIP_REPO_URL / PIP_USERNAME / PIP_PASSWORD are not set" >&2
exit 1
fi
- AUTH_URL="https://$PIP_USERNAME:$PIP_PASSWORD@$(echo "$PIP_REPO_URL" | sed -E 's|^[a-zA-Z]+://||; s|/*$||')/simple"
- pip install --index-url "$AUTH_URL" --extra-index-url https://pypi.org/simple/ -U ".[dev]" "pydoclint>=0.9.1"
- echo "Running quality gate..."
- python -m black --check .
- python -m ruff check .
- python -m mypy
- pydoclint .
- python -m pytest
- name: build-package - name: build-package
image: python:3.13-slim image: python:3.13-slim
commands: commands:
- pip install --upgrade pip build - pip install --upgrade pip build
- echo "Building Python package..." - echo "📦 Building Python package..."
- python -m build - python -m build
- ls -l dist - ls -l dist
@@ -81,7 +51,7 @@ steps:
from_secret: PIP_PASSWORD from_secret: PIP_PASSWORD
commands: commands:
- pip install --upgrade twine - pip install --upgrade twine
- echo "Uploading to private PyPI at $PIP_REPO_URL ..." - echo "🚀 Uploading to private PyPI at $PIP_REPO_URL ..."
- | - |
twine upload \ twine upload \
--repository-url "$PIP_REPO_URL" \ --repository-url "$PIP_REPO_URL" \
@@ -128,31 +98,25 @@ steps:
set -e set -e
PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | cut -d'"' -f2) PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | cut -d'"' -f2)
echo "Package: $PACKAGE_NAME" echo "📦 Package: $PACKAGE_NAME"
for TAG in $(git tag --sort=version:refname); do for TAG in $(git tag --sort=version:refname); do
VERSION="$TAG" VERSION="$TAG"
echo "Version: $VERSION" echo "🔁 Version: $VERSION"
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" \ if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" \
"$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then
echo "Exists, skipping" echo "⏭️ Exists, skipping"
continue continue
fi fi
git checkout --force "$TAG" git checkout --force "$TAG"
TAG_VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2) echo "🏗️ Building $VERSION"
if [ "$TAG" != "$TAG_VERSION" ]; then
echo "Tag $TAG != pyproject version $TAG_VERSION at that commit; skipping"
continue
fi
echo "Building $VERSION"
rm -rf dist rm -rf dist
python -m build python -m build
echo "Uploading $VERSION" echo "⬆️ Uploading $VERSION"
twine upload \ twine upload \
--repository-url "$PIP_REPO_URL" \ --repository-url "$PIP_REPO_URL" \
-u "$PIP_USERNAME" \ -u "$PIP_USERNAME" \

8
.gitignore vendored
View File

@@ -25,17 +25,10 @@ env/
htmlcov/ htmlcov/
coverage.xml coverage.xml
# Lint / type checking
.mypy_cache/
.ruff_cache/
# Environment variables # Environment variables
.env .env
.env.local .env.local
# Docs build artifacts
site
# OS # OS
.DS_Store .DS_Store
Thumbs.db Thumbs.db
@@ -45,3 +38,4 @@ Thumbs.db
*.swo *.swo
*~ *~
*.tmp *.tmp
site

View File

@@ -1,35 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.7] - 2026-10-17
### Added
- `py.typed` marker for PEP 561 type information.
- Route code generation: template-style async route stubs with a body parameter
and service hint; resource-name sanitisation; `--inject-request` /
`--package` options; expanded form bodies.
- Type stubs for the `cli`, `codegen`, and `security` modules.
- Hand-written wiki, plus doc-forge-generated API reference under `docs/lib`
and MCP bundle under `docs/mcp` (per-kind MkDocs configs).
- MIT `LICENSE`.
### Changed
- Adopted the standard Type A PyPI CI pipeline: a `tag == version` guard and a
quality gate (black, ruff, mypy, pydoclint, pytest).
- Standardized `pyproject.toml` (canonical packaging, lint tool config, extras)
with a shared Google-style `[tool.pydoclint]` configuration.
- `templates/` excluded from black/ruff scans.
### Fixed
- Binder/app route annotations tightened (FastAPI / `ModuleType`);
`binder.pyi` synced with the signature.
- Stub fixes for typed API surfaces.
[Unreleased]: https://git.aetoskia.com/aetos/openapi-first/compare/0.0.7...HEAD
[0.0.7]: https://git.aetoskia.com/aetos/openapi-first/compare/0.0.6...0.0.7

21
LICENSE
View File

@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2026 Aetoskia Platform
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1,13 +1,10 @@
home: lib/index.md home: index.md
groups: groups:
Application Bootstrap: Application Bootstrap:
- lib/app.md - app.md
- lib/binder.md - binder.md
Core Utilities: Core Utilities:
- lib/loader.md - loader.md
- lib/errors.md - errors.md
OpenAPI Client: OpenAPI Client:
- lib/client.md - client.md
icon:
logo: material/api
repo: fontawesome/brands/github

View File

@@ -1,4 +1,3 @@
# openapi_first # openapi_first
::: openapi_first ::: openapi_first
- [Openapi First](openapi_first/)

View File

@@ -1,3 +0,0 @@
# Codegen
::: openapi_first.codegen

View File

@@ -1,3 +0,0 @@
# Codegen Routes
::: openapi_first.codegen_routes

View File

@@ -1,3 +0,0 @@
# App
::: openapi_first.app

View File

@@ -1,3 +0,0 @@
# Binder
::: openapi_first.binder

View File

@@ -1,3 +0,0 @@
# Cli
::: openapi_first.cli

View File

@@ -1,3 +0,0 @@
# Client
::: openapi_first.client

View File

@@ -1,3 +0,0 @@
# Codegen
::: openapi_first.codegen

View File

@@ -1,3 +0,0 @@
# Codegen Routes
::: openapi_first.codegen_routes

View File

@@ -1,3 +0,0 @@
# Errors
::: openapi_first.errors

View File

@@ -1,13 +0,0 @@
# Openapi First
::: openapi_first
- [App](app.md)
- [Binder](binder.md)
- [Cli](cli.md)
- [Client](client.md)
- [Codegen](codegen.md)
- [Codegen Routes](codegen_routes.md)
- [Errors](errors.md)
- [Loader](loader.md)
- [Security](security.md)
- [Templates](templates/)

View File

@@ -1,3 +0,0 @@
# Loader
::: openapi_first.loader

View File

@@ -1,3 +0,0 @@
# Security
::: openapi_first.security

View File

@@ -1,7 +0,0 @@
# Crud App
::: openapi_first.templates.crud_app
- [Data](data.md)
- [Main](main.md)
- [Routes](routes.md)
- [Test Crud App](test_crud_app.md)

View File

@@ -1,5 +0,0 @@
# Health App
::: openapi_first.templates.health_app
- [Main](main.md)
- [Routes](routes.md)

View File

@@ -1,7 +0,0 @@
# Templates
::: openapi_first.templates
- [Crud App](crud_app/)
- [Health App](health_app/)
- [Model App](model_app/)
- [Vet App](vet_app/)

View File

@@ -1,8 +0,0 @@
# Model App
::: openapi_first.templates.model_app
- [Data](data.md)
- [Main](main.md)
- [Models](models.md)
- [Routes](routes.md)
- [Test Model App](test_model_app.md)

View File

@@ -1,3 +0,0 @@
# Data
::: openapi_first.templates.vet_app.data

View File

@@ -1,9 +0,0 @@
# Vet App
::: openapi_first.templates.vet_app
- [Data](data.md)
- [Main](main.md)
- [Models](models.md)
- [Routes](routes.md)
- [Sse](sse.md)
- [Test Vet App](test_vet_app.md)

View File

@@ -1,3 +0,0 @@
# Main
::: openapi_first.templates.vet_app.main

View File

@@ -1,3 +0,0 @@
# Models
::: openapi_first.templates.vet_app.models

View File

@@ -1,3 +0,0 @@
# Routes
::: openapi_first.templates.vet_app.routes

View File

@@ -1,3 +0,0 @@
# Sse
::: openapi_first.templates.vet_app.sse

View File

@@ -1,3 +0,0 @@
# Test Vet App
::: openapi_first.templates.vet_app.test_vet_app

View File

@@ -1,3 +0,0 @@
# Security
::: openapi_first.security

View File

@@ -1,3 +0,0 @@
# Data
::: openapi_first.templates.crud_app.data

View File

@@ -1,3 +0,0 @@
# Main
::: openapi_first.templates.crud_app.main

View File

@@ -1,3 +0,0 @@
# Routes
::: openapi_first.templates.crud_app.routes

View File

@@ -1,3 +0,0 @@
# Test Crud App
::: openapi_first.templates.crud_app.test_crud_app

View File

@@ -1,3 +0,0 @@
# Main
::: openapi_first.templates.health_app.main

View File

@@ -1,3 +0,0 @@
# Routes
::: openapi_first.templates.health_app.routes

View File

@@ -1,3 +0,0 @@
# Data
::: openapi_first.templates.model_app.data

View File

@@ -1,3 +0,0 @@
# Main
::: openapi_first.templates.model_app.main

View File

@@ -1,3 +0,0 @@
# Models
::: openapi_first.templates.model_app.models

View File

@@ -1,3 +0,0 @@
# Routes
::: openapi_first.templates.model_app.routes

View File

@@ -1,3 +0,0 @@
# Test Model App
::: openapi_first.templates.model_app.test_model_app

View File

@@ -1,3 +0,0 @@
# Data
::: openapi_first.templates.vet_app.data

View File

@@ -1,3 +0,0 @@
# Vet App
::: openapi_first.templates.vet_app

View File

@@ -1,3 +0,0 @@
# Main
::: openapi_first.templates.vet_app.main

View File

@@ -1,3 +0,0 @@
# Models
::: openapi_first.templates.vet_app.models

View File

@@ -1,3 +0,0 @@
# Routes
::: openapi_first.templates.vet_app.routes

View File

@@ -1,3 +0,0 @@
# Sse
::: openapi_first.templates.vet_app.sse

View File

@@ -1,3 +0,0 @@
# Test Vet App
::: openapi_first.templates.vet_app.test_vet_app

View File

@@ -1,53 +0,0 @@
{
"module": "openapi_first.app",
"content": {
"path": "openapi_first.app",
"docstring": "# Summary\n\nOpenAPI-first application bootstrap for FastAPI.\n\nThis module provides `OpenAPIFirstApp`, a thin but strict abstraction\nthat enforces OpenAPI as the single source of truth for a FastAPI service.\n\nNotes:\n **Core Principles:**\n\n - The OpenAPI specification (JSON or YAML) defines the entire API surface.\n - Every `operationId` in the OpenAPI spec must have a corresponding\n Python handler function.\n - Handlers are plain Python callables (no FastAPI decorators).\n - FastAPI route registration is derived exclusively from the spec.\n - FastAPI's autogenerated OpenAPI schema is fully overridden.\n\n **Responsibilities:**\n\n - Loads and validates an OpenAPI 3.x specification.\n - Dynamically binds HTTP routes to handler functions using `operationId`.\n - Registers routes with FastAPI at application startup.\n - Ensures runtime behavior matches the OpenAPI contract exactly.\n\n **Constraints:**\n\n - This module intentionally does NOT:\n - Generate OpenAPI specs.\n - Generate client code.\n - Introduce a new framework or lifecycle.\n - Alter FastAPI dependency injection semantics.",
"objects": {
"bind_routes": {
"name": "bind_routes",
"kind": "function",
"path": "openapi_first.app.bind_routes",
"signature": "bind_routes(app: FastAPI, spec: dict[str, Any], routes_module: ModuleType, security_deps: dict[str, list[Any]] | None = None)",
"docstring": "Bind OpenAPI operations to FastAPI routes.\n\nArgs:\n app (FastAPI):\n The FastAPI application instance to which routes will be added.\n spec (dict[str, Any]):\n Parsed OpenAPI 3.x specification dictionary.\n routes_module (ModuleType):\n Python module containing handler functions. Each handler's name MUST\n exactly match an OpenAPI `operationId`.\n security_deps (dict[str, list[Any]] | None):\n Optional mapping of ``METHOD:/path`` → ``list[Depends(...)]``\n generated from the spec's ``securitySchemes`` and per-operation\n ``security`` fields.\n\nRaises:\n MissingOperationHandler:\n If an ``operationId`` is missing from the spec or if no corresponding\n handler function exists in the routes module.\n\nNotes:\n **Responsibilities:**\n\n - Iterates through the OpenAPI specification paths and methods.\n - Resolves each ``operationId`` to a handler function, and registers\n a corresponding ``APIRoute`` on the FastAPI application.\n - Injects FastAPI ``Depends()`` for each security requirement found\n on the operation or inherited from the top-level ``security`` field.\n\n **Guarantees:**\n\n - Route registration is deterministic and spec-driven. No route\n decorators are required or supported. Handler resolution errors\n surface at application startup."
},
"load_openapi": {
"name": "load_openapi",
"kind": "function",
"path": "openapi_first.app.load_openapi",
"signature": "load_openapi(path: str | Path)",
"docstring": "Load and validate an OpenAPI 3.x specification from disk.\n\nArgs:\n path (str | Path):\n Filesystem path to an OpenAPI specification file. Supported\n extensions: `.json`, `.yaml`, `.yml`.\n\nReturns:\n dict[str, Any]:\n Parsed and validated OpenAPI specification.\n\nRaises:\n OpenAPISpecLoadError:\n If the file does not exist, cannot be parsed, or fails OpenAPI\n schema validation.\n\nNotes:\n **Guarantees:**\n\n - The specification is parsed based on file extension and validated\n using a strict OpenAPI schema validator.\n - Any error results in an immediate exception, preventing\n application startup."
},
"make_security_dependencies": {
"name": "make_security_dependencies",
"kind": "function",
"path": "openapi_first.app.make_security_dependencies",
"signature": "make_security_dependencies(spec: dict[str, Any], security_schemes: dict[str, dict[str, Any]])",
"docstring": "Build a mapping of ``METHOD:/path`` → list of ``Depends(...)``.\n\nThe effective security for each operation is resolved by:\n\n1. Using the operation-level ``security`` field if present.\n2. Falling back to the top-level ``security`` field.\n3. An empty list means *no auth required* for that operation."
},
"parse_security_schemes": {
"name": "parse_security_schemes",
"kind": "function",
"path": "openapi_first.app.parse_security_schemes",
"signature": "parse_security_schemes(spec: dict[str, Any])",
"docstring": "Extract and resolve environment variables in security schemes."
},
"OpenAPIFirstApp": {
"name": "OpenAPIFirstApp",
"kind": "class",
"path": "openapi_first.app.OpenAPIFirstApp",
"signature": "OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)",
"docstring": "FastAPI application enforcing OpenAPI-first design.\n\nArgs:\n openapi_path (str):\n Filesystem path to the OpenAPI 3.x specification file. This\n specification is treated as the authoritative API contract.\n routes_module (ModuleType):\n Python module containing handler functions whose names correspond\n exactly to OpenAPI ``operationId`` values.\n **fastapi_kwargs (Any):\n Additional keyword arguments passed directly to\n ``fastapi.FastAPI`` (e.g., title, version, middleware, lifespan\n handlers).\n\nRaises:\n OpenAPIFirstError:\n If the OpenAPI specification is invalid, or if any declared\n ``operationId`` does not have a corresponding handler function.\n\nNotes:\n **Responsibilities:**\n\n - `OpenAPIFirstApp` subclasses `FastAPI` and replaces manual route\n registration with OpenAPI-driven binding.\n - All routes are derived from the provided OpenAPI specification,\n and each ``operationId`` is mapped to a Python function in the\n supplied routes module.\n - Auth dependencies are auto-injected from the spec's\n ``securitySchemes`` and per-operation ``security`` fields.\n\n **Guarantees:**\n\n - No route can exist without an OpenAPI declaration.\n - No OpenAPI operation can exist without a handler.\n - Swagger UI and ``/openapi.json`` always reflect the provided spec.\n - Handler functions remain framework-agnostic and testable.\n - Auth enforcement is driven entirely by the spec — no manual\n middleware or decorators required.\n\nExample:\n ```python\n from openapi_first.app import OpenAPIFirstApp\n import app.routes as routes\n\n app = OpenAPIFirstApp(\n openapi_path=\"app/openapi.json\",\n routes_module=routes,\n title=\"Example Service\",\n )\n ```",
"members": {
"openapi": {
"name": "openapi",
"kind": "attribute",
"path": "openapi_first.app.OpenAPIFirstApp.openapi",
"signature": null,
"docstring": null
}
}
}
}
}
}

View File

@@ -1,23 +0,0 @@
{
"module": "openapi_first.binder",
"content": {
"path": "openapi_first.binder",
"docstring": "# Summary\n\nOpenAPI-driven route binding for FastAPI.\n\nThis module is responsible for translating an OpenAPI 3.x specification\ninto concrete FastAPI routes. It enforces a strict one-to-one mapping\nbetween OpenAPI operations and Python handler functions using `operationId`.\n\nNotes:\n **Core Responsibility:**\n\n - Read path + method definitions from an OpenAPI specification.\n - Resolve each `operationId` to a Python callable.\n - Register routes with FastAPI using `APIRoute`.\n - Fail fast when contract violations are detected.\n\n **Design Constraints:**\n\n - All routes MUST be declared in the OpenAPI specification.\n - All OpenAPI operations MUST define an `operationId`.\n - Every `operationId` MUST resolve to a handler function.\n - Handlers are plain Python callables (no decorators required).\n - No implicit route creation or inference is allowed.\n\n **Constraints:**\n\n - This module intentionally does NOT:\n - Perform request or response validation.\n - Generate Pydantic models.\n - Modify FastAPI dependency injection.\n - Interpret OpenAPI semantics beyond routing metadata.",
"objects": {
"MissingOperationHandler": {
"name": "MissingOperationHandler",
"kind": "class",
"path": "openapi_first.binder.MissingOperationHandler",
"signature": "MissingOperationHandler(*, path: str, method: str, operation_id: str | None = None)",
"docstring": "Raised when an OpenAPI operation cannot be resolved to a handler.\n\nArgs:\n path (str):\n The HTTP path declared in the OpenAPI specification.\n method (str):\n The HTTP method (as declared in the OpenAPI spec).\n operation_id (str | None):\n The operationId declared in the OpenAPI spec, if present.\n\nNotes:\n **Scenarios:**\n\n - An OpenAPI operation does not define an `operationId`.\n - An `operationId` is defined but no matching function exists in\n the provided routes module.\n\n **Guarantees:**\n\n - This represents a violation of the OpenAPI-first contract and\n indicates that the specification and implementation are out of\n sync."
},
"bind_routes": {
"name": "bind_routes",
"kind": "function",
"path": "openapi_first.binder.bind_routes",
"signature": "bind_routes(app: FastAPI, spec: dict[str, Any], routes_module: ModuleType, security_deps: dict[str, list[Any]] | None = None) -> None",
"docstring": "Bind OpenAPI operations to FastAPI routes.\n\nArgs:\n app (FastAPI):\n The FastAPI application instance to which routes will be added.\n spec (dict[str, Any]):\n Parsed OpenAPI 3.x specification dictionary.\n routes_module (ModuleType):\n Python module containing handler functions. Each handler's name MUST\n exactly match an OpenAPI `operationId`.\n security_deps (dict[str, list[Any]] | None):\n Optional mapping of ``METHOD:/path`` → ``list[Depends(...)]``\n generated from the spec's ``securitySchemes`` and per-operation\n ``security`` fields.\n\nRaises:\n MissingOperationHandler:\n If an ``operationId`` is missing from the spec or if no corresponding\n handler function exists in the routes module.\n\nNotes:\n **Responsibilities:**\n\n - Iterates through the OpenAPI specification paths and methods.\n - Resolves each ``operationId`` to a handler function, and registers\n a corresponding ``APIRoute`` on the FastAPI application.\n - Injects FastAPI ``Depends()`` for each security requirement found\n on the operation or inherited from the top-level ``security`` field.\n\n **Guarantees:**\n\n - Route registration is deterministic and spec-driven. No route\n decorators are required or supported. Handler resolution errors\n surface at application startup."
}
}
}
}

View File

@@ -1,37 +0,0 @@
{
"module": "openapi_first.cli",
"content": {
"path": "openapi_first.cli",
"docstring": "# Summary\n\nCommand-line interface for FastAPI OpenAPI-first scaffolding utilities.\n\nThis CLI bootstraps OpenAPI-first FastAPI applications from versioned,\nbundled templates packaged with the library.",
"objects": {
"DEFAULT_TEMPLATE": {
"name": "DEFAULT_TEMPLATE",
"kind": "attribute",
"path": "openapi_first.cli.DEFAULT_TEMPLATE",
"signature": null,
"docstring": null
},
"available_templates": {
"name": "available_templates",
"kind": "function",
"path": "openapi_first.cli.available_templates",
"signature": "available_templates() -> list[str]",
"docstring": "Return a list of available application templates.\n\nReturns:\n list[str]:\n Sorted list of template names found in the internal templates directory."
},
"copy_template": {
"name": "copy_template",
"kind": "function",
"path": "openapi_first.cli.copy_template",
"signature": "copy_template(template: str, target_dir: Path) -> None",
"docstring": "Copy a bundled OpenAPI-first application template into a directory.\n\nArgs:\n template (str):\n Name of the template to copy.\n target_dir (Path):\n Filesystem path where the template should be copied.\n\nRaises:\n FileNotFoundError:\n If the requested template does not exist."
},
"main": {
"name": "main",
"kind": "function",
"path": "openapi_first.cli.main",
"signature": "main() -> None",
"docstring": null
}
}
}
}

View File

@@ -1,23 +0,0 @@
{
"module": "openapi_first.codegen",
"content": {
"path": "openapi_first.codegen",
"docstring": "# Summary\n\nCore logic for generating Python source code from OpenAPI specifications.\n\nThis module provides reusable utilities for code generation, specifically\ngenerating Pydantic models and route handler stubs from OpenAPI 3.x schema\ndefinitions.",
"objects": {
"generate_routes": {
"name": "generate_routes",
"kind": "function",
"path": "openapi_first.codegen.generate_routes",
"signature": "generate_routes(spec_path: Path, output_dir: Path, *, use_models: bool = False, models_module: str = 'models', inject_request: bool = False, package: bool = False, template_style: bool = False)",
"docstring": "Generate route handler stubs from an OpenAPI specification.\n\nCreates one route module per resource in *output_dir*. Resources are\nderived from the first path segment (e.g. ``/pets`` and ``/pets/{id}``\nboth group under ``pets``) and sanitized to valid module identifiers.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI specification file (YAML or JSON).\n output_dir (Path):\n Directory where the generated route files are written.\n Created automatically if it does not exist.\n use_models (bool, optional):\n If ``True``, import Pydantic models from *models_module*\n for request-body schemas referenced via ``$ref``.\n models_module (str, optional):\n Dotted Python module path from which to import models\n (e.g. ``\"models\"``, ``\"app.models\"``).\n inject_request (bool, optional):\n If ``True``, prepend ``request: Request`` to every handler so the\n stub can later resolve services from ``request.app.state``.\n package (bool, optional):\n If ``True``, emit ``<resource>/routes.py`` packages (each with an\n ``__init__.py``) instead of flat ``<resource>.py`` modules.\n template_style (bool, optional):\n If ``True``, emit ``async def`` handlers with a JSON body parameter\n named ``body`` (the standards-template convention) plus a\n service-resolution hint comment, instead of sync ``def`` handlers\n taking ``payload``.\n\nReturns:\n list[Path]:\n Absolute paths of every generated route file.\n\nRaises:\n OpenAPISpecLoadError:\n If the spec cannot be loaded or validated.\n ValueError:\n If any operation is missing ``operationId``."
},
"generate_models": {
"name": "generate_models",
"kind": "function",
"path": "openapi_first.codegen.generate_models",
"signature": "generate_models(spec_path: Path, output_path: Path, pydantic_version: int = 2) -> None",
"docstring": "Generate Pydantic models from an OpenAPI specification.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI specification file (YAML or JSON).\n output_path (Path):\n Path where the generated Python code should be written.\n pydantic_version (int, optional):\n The Pydantic version to target (1 or 2). Defaults to 2.\n\nNotes:\n **Reusability:**\n This function is designed to be used by the CLI and can be\n exposed as an MCP tool without modification."
}
}
}
}

View File

@@ -1,23 +0,0 @@
{
"module": "openapi_first.codegen_routes",
"content": {
"path": "openapi_first.codegen_routes",
"docstring": "# Summary\n\nRoute handler code generation from OpenAPI specifications.\n\nThis module generates Python route handler stubs from an OpenAPI 3.x\nspecification. Each resource (derived from the first path segment)\ngets its own file under the output directory. Every OpenAPI operation\nmust define an ``operationId``, which becomes the handler function name.\n\nNotes:\n **Design constraints:**\n\n - ``operationId`` is required on every operation (matching\n ``binder.bind_routes``).\n - Handlers are stubs raising ``NotImplementedError``.\n - Sub-resources (e.g. ``/pets/{id}/photo``) are grouped with their\n parent resource (``pets``).\n - Parameter types and defaults are inferred from the spec.\n - ``response: Response`` is injected for non-200 success codes.\n - Resource names are sanitized to valid Python module identifiers,\n so a path such as ``/fetch-requests`` yields ``fetch_requests.py``.\n - Passing ``inject_request=True`` prepends ``request: Request`` to\n every handler (the composition-root / DI convention).\n - ``multipart/form-data`` and\n ``application/x-www-form-urlencoded`` request bodies expand to one\n parameter per schema property (``UploadFile`` / ``File`` / ``Form``)\n instead of an opaque ``payload: dict``.\n - Passing ``package=True`` writes ``<resource>/routes.py`` (with\n ``__init__.py`` sidecars) instead of a flat ``<resource>.py``.\n - Passing ``template_style=True`` emits ``async def`` handlers whose\n JSON body parameter is named ``body`` (matching the standards\n template) and adds a service-resolution hint comment.",
"objects": {
"load_openapi": {
"name": "load_openapi",
"kind": "function",
"path": "openapi_first.codegen_routes.load_openapi",
"signature": "load_openapi(path: str | Path)",
"docstring": "Load and validate an OpenAPI 3.x specification from disk.\n\nArgs:\n path (str | Path):\n Filesystem path to an OpenAPI specification file. Supported\n extensions: `.json`, `.yaml`, `.yml`.\n\nReturns:\n dict[str, Any]:\n Parsed and validated OpenAPI specification.\n\nRaises:\n OpenAPISpecLoadError:\n If the file does not exist, cannot be parsed, or fails OpenAPI\n schema validation.\n\nNotes:\n **Guarantees:**\n\n - The specification is parsed based on file extension and validated\n using a strict OpenAPI schema validator.\n - Any error results in an immediate exception, preventing\n application startup."
},
"generate_routes": {
"name": "generate_routes",
"kind": "function",
"path": "openapi_first.codegen_routes.generate_routes",
"signature": "generate_routes(spec_path: Path, output_dir: Path, *, use_models: bool = False, models_module: str = 'models', inject_request: bool = False, package: bool = False, template_style: bool = False) -> list[Path]",
"docstring": "Generate route handler stubs from an OpenAPI specification.\n\nCreates one route module per resource in *output_dir*. Resources are\nderived from the first path segment (e.g. ``/pets`` and ``/pets/{id}``\nboth group under ``pets``) and sanitized to valid module identifiers.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI specification file (YAML or JSON).\n output_dir (Path):\n Directory where the generated route files are written.\n Created automatically if it does not exist.\n use_models (bool, optional):\n If ``True``, import Pydantic models from *models_module*\n for request-body schemas referenced via ``$ref``.\n models_module (str, optional):\n Dotted Python module path from which to import models\n (e.g. ``\"models\"``, ``\"app.models\"``).\n inject_request (bool, optional):\n If ``True``, prepend ``request: Request`` to every handler so the\n stub can later resolve services from ``request.app.state``.\n package (bool, optional):\n If ``True``, emit ``<resource>/routes.py`` packages (each with an\n ``__init__.py``) instead of flat ``<resource>.py`` modules.\n template_style (bool, optional):\n If ``True``, emit ``async def`` handlers with a JSON body parameter\n named ``body`` (the standards-template convention) plus a\n service-resolution hint comment, instead of sync ``def`` handlers\n taking ``payload``.\n\nReturns:\n list[Path]:\n Absolute paths of every generated route file.\n\nRaises:\n OpenAPISpecLoadError:\n If the spec cannot be loaded or validated.\n ValueError:\n If any operation is missing ``operationId``."
}
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,23 +0,0 @@
{
"module": "openapi_first.security",
"content": {
"path": "openapi_first.security",
"docstring": "# Summary\n\nOpenAPI security scheme parsing and auto-generated auth dependencies.\n\nThis module reads `securitySchemes` and per-operation `security` from an\nOpenAPI spec, resolves `{ENV_VAR}` placeholders in `x-` extension fields,\nand generates FastAPI dependencies for token validation (e.g., Bearer JWT\nintrospection).",
"objects": {
"parse_security_schemes": {
"name": "parse_security_schemes",
"kind": "function",
"path": "openapi_first.security.parse_security_schemes",
"signature": "parse_security_schemes(spec: dict[str, Any]) -> dict[str, dict[str, Any]]",
"docstring": "Extract and resolve environment variables in security schemes."
},
"make_security_dependencies": {
"name": "make_security_dependencies",
"kind": "function",
"path": "openapi_first.security.make_security_dependencies",
"signature": "make_security_dependencies(spec: dict[str, Any], security_schemes: dict[str, dict[str, Any]]) -> dict[str, list[Any]]",
"docstring": "Build a mapping of ``METHOD:/path`` → list of ``Depends(...)``.\n\nThe effective security for each operation is resolved by:\n\n1. Using the operation-level ``security`` field if present.\n2. Falling back to the top-level ``security`` field.\n3. An empty list means *no auth required* for that operation."
}
}
}
}

View File

@@ -1,32 +0,0 @@
{
"module": "openapi_first.templates.crud_app.main",
"content": {
"path": "openapi_first.templates.crud_app.main",
"docstring": "Application entry point for an OpenAPI-first CRUD example service.\n\nThis module constructs a FastAPI application exclusively from an\nOpenAPI specification and a handler namespace, without using\ndecorator-driven routing.\n\nAll HTTP routes, methods, request/response schemas, and operation\nbindings are defined in the OpenAPI document referenced by\n``openapi_path``. Python callables defined in the ``routes`` module are\nbound to OpenAPI operations strictly via ``operationId``.\n\nThis module contains no routing logic, persistence concerns, or\nframework configuration beyond application assembly.\n\nDesign guarantees:\n- OpenAPI is the single source of truth\n- No undocumented routes can exist\n- Every OpenAPI operationId must resolve to exactly one handler\n- All contract violations fail at application startup\n\nThis file is intended to be used as the ASGI entry point.\n\nExample:\n uvicorn main:app",
"objects": {
"OpenAPIFirstApp": {
"name": "OpenAPIFirstApp",
"kind": "class",
"path": "openapi_first.templates.crud_app.main.OpenAPIFirstApp",
"signature": "OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)",
"docstring": "FastAPI application enforcing OpenAPI-first design.\n\nArgs:\n openapi_path (str):\n Filesystem path to the OpenAPI 3.x specification file. This\n specification is treated as the authoritative API contract.\n routes_module (ModuleType):\n Python module containing handler functions whose names correspond\n exactly to OpenAPI ``operationId`` values.\n **fastapi_kwargs (Any):\n Additional keyword arguments passed directly to\n ``fastapi.FastAPI`` (e.g., title, version, middleware, lifespan\n handlers).\n\nRaises:\n OpenAPIFirstError:\n If the OpenAPI specification is invalid, or if any declared\n ``operationId`` does not have a corresponding handler function.\n\nNotes:\n **Responsibilities:**\n\n - `OpenAPIFirstApp` subclasses `FastAPI` and replaces manual route\n registration with OpenAPI-driven binding.\n - All routes are derived from the provided OpenAPI specification,\n and each ``operationId`` is mapped to a Python function in the\n supplied routes module.\n - Auth dependencies are auto-injected from the spec's\n ``securitySchemes`` and per-operation ``security`` fields.\n\n **Guarantees:**\n\n - No route can exist without an OpenAPI declaration.\n - No OpenAPI operation can exist without a handler.\n - Swagger UI and ``/openapi.json`` always reflect the provided spec.\n - Handler functions remain framework-agnostic and testable.\n - Auth enforcement is driven entirely by the spec — no manual\n middleware or decorators required.\n\nExample:\n ```python\n from openapi_first.app import OpenAPIFirstApp\n import app.routes as routes\n\n app = OpenAPIFirstApp(\n openapi_path=\"app/openapi.json\",\n routes_module=routes,\n title=\"Example Service\",\n )\n ```",
"members": {
"openapi": {
"name": "openapi",
"kind": "attribute",
"path": "openapi_first.templates.crud_app.main.OpenAPIFirstApp.openapi",
"signature": null,
"docstring": null
}
}
},
"app": {
"name": "app",
"kind": "attribute",
"path": "openapi_first.templates.crud_app.main.app",
"signature": null,
"docstring": null
}
}
}
}

View File

@@ -1,32 +0,0 @@
{
"module": "openapi_first.templates.health_app.main",
"content": {
"path": "openapi_first.templates.health_app.main",
"docstring": "Application entry point for an OpenAPI-first FastAPI service.\n\nThis module constructs a FastAPI application exclusively from an\nOpenAPI specification and a handler namespace, without using\ndecorator-driven routing.\n\nAll HTTP routes, methods, and operation bindings are defined in the\nOpenAPI document referenced by ``openapi_path``. Python callables\ndefined in the ``routes`` module are bound to OpenAPI operations\nstrictly via ``operationId``.\n\nThis module contains no routing logic, request handling, or framework\nconfiguration beyond application assembly.\n\nDesign guarantees:\n- OpenAPI is the single source of truth\n- No undocumented routes can exist\n- Every OpenAPI operationId must resolve to exactly one handler\n- All contract violations fail at application startup\n\nThis file is intended to be used as the ASGI entry point.\n\nExample:\n uvicorn main:app",
"objects": {
"OpenAPIFirstApp": {
"name": "OpenAPIFirstApp",
"kind": "class",
"path": "openapi_first.templates.health_app.main.OpenAPIFirstApp",
"signature": "OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)",
"docstring": "FastAPI application enforcing OpenAPI-first design.\n\nArgs:\n openapi_path (str):\n Filesystem path to the OpenAPI 3.x specification file. This\n specification is treated as the authoritative API contract.\n routes_module (ModuleType):\n Python module containing handler functions whose names correspond\n exactly to OpenAPI ``operationId`` values.\n **fastapi_kwargs (Any):\n Additional keyword arguments passed directly to\n ``fastapi.FastAPI`` (e.g., title, version, middleware, lifespan\n handlers).\n\nRaises:\n OpenAPIFirstError:\n If the OpenAPI specification is invalid, or if any declared\n ``operationId`` does not have a corresponding handler function.\n\nNotes:\n **Responsibilities:**\n\n - `OpenAPIFirstApp` subclasses `FastAPI` and replaces manual route\n registration with OpenAPI-driven binding.\n - All routes are derived from the provided OpenAPI specification,\n and each ``operationId`` is mapped to a Python function in the\n supplied routes module.\n - Auth dependencies are auto-injected from the spec's\n ``securitySchemes`` and per-operation ``security`` fields.\n\n **Guarantees:**\n\n - No route can exist without an OpenAPI declaration.\n - No OpenAPI operation can exist without a handler.\n - Swagger UI and ``/openapi.json`` always reflect the provided spec.\n - Handler functions remain framework-agnostic and testable.\n - Auth enforcement is driven entirely by the spec — no manual\n middleware or decorators required.\n\nExample:\n ```python\n from openapi_first.app import OpenAPIFirstApp\n import app.routes as routes\n\n app = OpenAPIFirstApp(\n openapi_path=\"app/openapi.json\",\n routes_module=routes,\n title=\"Example Service\",\n )\n ```",
"members": {
"openapi": {
"name": "openapi",
"kind": "attribute",
"path": "openapi_first.templates.health_app.main.OpenAPIFirstApp.openapi",
"signature": null,
"docstring": null
}
}
},
"app": {
"name": "app",
"kind": "attribute",
"path": "openapi_first.templates.health_app.main.app",
"signature": null,
"docstring": null
}
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,32 +0,0 @@
{
"module": "openapi_first.templates.model_app.main",
"content": {
"path": "openapi_first.templates.model_app.main",
"docstring": "Application entry point for an OpenAPI-first model-based CRUD example service.\n\nThis module constructs a FastAPI application exclusively from an\nOpenAPI specification and a handler namespace, without using\ndecorator-driven routing.\n\nAll HTTP routes, methods, request/response schemas, and operation\nbindings are defined in the OpenAPI document referenced by\n``openapi_path``. Python callables defined in the ``routes`` module are\nbound to OpenAPI operations strictly via ``operationId``.\n\nThis module contains no routing logic, persistence concerns, or\nframework configuration beyond application assembly.\n\nDesign guarantees:\n- OpenAPI is the single source of truth\n- No undocumented routes can exist\n- Every OpenAPI operationId must resolve to exactly one handler\n- All contract violations fail at application startup\n\nThis file is intended to be used as the ASGI entry point.\n\nExample:\n uvicorn main:app",
"objects": {
"OpenAPIFirstApp": {
"name": "OpenAPIFirstApp",
"kind": "class",
"path": "openapi_first.templates.model_app.main.OpenAPIFirstApp",
"signature": "OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)",
"docstring": "FastAPI application enforcing OpenAPI-first design.\n\nArgs:\n openapi_path (str):\n Filesystem path to the OpenAPI 3.x specification file. This\n specification is treated as the authoritative API contract.\n routes_module (ModuleType):\n Python module containing handler functions whose names correspond\n exactly to OpenAPI ``operationId`` values.\n **fastapi_kwargs (Any):\n Additional keyword arguments passed directly to\n ``fastapi.FastAPI`` (e.g., title, version, middleware, lifespan\n handlers).\n\nRaises:\n OpenAPIFirstError:\n If the OpenAPI specification is invalid, or if any declared\n ``operationId`` does not have a corresponding handler function.\n\nNotes:\n **Responsibilities:**\n\n - `OpenAPIFirstApp` subclasses `FastAPI` and replaces manual route\n registration with OpenAPI-driven binding.\n - All routes are derived from the provided OpenAPI specification,\n and each ``operationId`` is mapped to a Python function in the\n supplied routes module.\n - Auth dependencies are auto-injected from the spec's\n ``securitySchemes`` and per-operation ``security`` fields.\n\n **Guarantees:**\n\n - No route can exist without an OpenAPI declaration.\n - No OpenAPI operation can exist without a handler.\n - Swagger UI and ``/openapi.json`` always reflect the provided spec.\n - Handler functions remain framework-agnostic and testable.\n - Auth enforcement is driven entirely by the spec — no manual\n middleware or decorators required.\n\nExample:\n ```python\n from openapi_first.app import OpenAPIFirstApp\n import app.routes as routes\n\n app = OpenAPIFirstApp(\n openapi_path=\"app/openapi.json\",\n routes_module=routes,\n title=\"Example Service\",\n )\n ```",
"members": {
"openapi": {
"name": "openapi",
"kind": "attribute",
"path": "openapi_first.templates.model_app.main.OpenAPIFirstApp.openapi",
"signature": null,
"docstring": null
}
}
},
"app": {
"name": "app",
"kind": "attribute",
"path": "openapi_first.templates.model_app.main.app",
"signature": null,
"docstring": null
}
}
}
}

View File

@@ -1,184 +0,0 @@
{
"module": "openapi_first.templates.vet_app.data",
"content": {
"path": "openapi_first.templates.vet_app.data",
"docstring": "In-memory data store for the Veterinary Clinic example.\n\nThis module is NOT thread-safe and is intended for demos and scaffolds only.\n\nIt provides minimal, process-local data stores for the five veterinary\nclinic entities. Each store exposes standard CRUD operations backed by\na simple dictionary.\n\nThis module intentionally avoids:\n- persistence\n- concurrency guarantees\n- transactional semantics\n- validation beyond what Pydantic provides\n\nThis module is not part of the ``openapi_first`` library API surface.",
"objects": {
"list_parents": {
"name": "list_parents",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.list_parents",
"signature": "list_parents() -> list[Parent]",
"docstring": null
},
"get_parent": {
"name": "get_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.get_parent",
"signature": "get_parent(parent_id: int) -> Parent",
"docstring": null
},
"create_parent": {
"name": "create_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.create_parent",
"signature": "create_parent(payload: ParentCreate) -> Parent",
"docstring": null
},
"update_parent": {
"name": "update_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.update_parent",
"signature": "update_parent(parent_id: int, payload: ParentCreate) -> Parent",
"docstring": null
},
"delete_parent": {
"name": "delete_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.delete_parent",
"signature": "delete_parent(parent_id: int) -> None",
"docstring": null
},
"list_vets": {
"name": "list_vets",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.list_vets",
"signature": "list_vets() -> list[Vet]",
"docstring": null
},
"get_vet": {
"name": "get_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.get_vet",
"signature": "get_vet(vet_id: int) -> Vet",
"docstring": null
},
"create_vet": {
"name": "create_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.create_vet",
"signature": "create_vet(payload: VetCreate) -> Vet",
"docstring": null
},
"update_vet": {
"name": "update_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.update_vet",
"signature": "update_vet(vet_id: int, payload: VetCreate) -> Vet",
"docstring": null
},
"delete_vet": {
"name": "delete_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.delete_vet",
"signature": "delete_vet(vet_id: int) -> None",
"docstring": null
},
"list_treatments": {
"name": "list_treatments",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.list_treatments",
"signature": "list_treatments() -> list[Treatment]",
"docstring": null
},
"get_treatment": {
"name": "get_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.get_treatment",
"signature": "get_treatment(treatment_id: int) -> Treatment",
"docstring": null
},
"create_treatment": {
"name": "create_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.create_treatment",
"signature": "create_treatment(payload: TreatmentCreate) -> Treatment",
"docstring": null
},
"update_treatment": {
"name": "update_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.update_treatment",
"signature": "update_treatment(treatment_id: int, payload: TreatmentCreate) -> Treatment",
"docstring": null
},
"delete_treatment": {
"name": "delete_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.delete_treatment",
"signature": "delete_treatment(treatment_id: int) -> None",
"docstring": null
},
"list_pets": {
"name": "list_pets",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.list_pets",
"signature": "list_pets() -> list[Pet]",
"docstring": null
},
"get_pet": {
"name": "get_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.get_pet",
"signature": "get_pet(pet_id: int) -> Pet",
"docstring": null
},
"create_pet": {
"name": "create_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.create_pet",
"signature": "create_pet(payload: PetCreate) -> Pet",
"docstring": null
},
"update_pet": {
"name": "update_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.update_pet",
"signature": "update_pet(pet_id: int, payload: PetCreate) -> Pet",
"docstring": null
},
"delete_pet": {
"name": "delete_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.delete_pet",
"signature": "delete_pet(pet_id: int) -> None",
"docstring": null
},
"list_appointments": {
"name": "list_appointments",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.list_appointments",
"signature": "list_appointments() -> list[Appointment]",
"docstring": null
},
"get_appointment": {
"name": "get_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.get_appointment",
"signature": "get_appointment(appointment_id: int) -> Appointment",
"docstring": null
},
"create_appointment": {
"name": "create_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.create_appointment",
"signature": "create_appointment(payload: AppointmentCreate) -> Appointment",
"docstring": null
},
"update_appointment": {
"name": "update_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.update_appointment",
"signature": "update_appointment(appointment_id: int, payload: AppointmentCreate) -> Appointment",
"docstring": null
},
"delete_appointment": {
"name": "delete_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.data.delete_appointment",
"signature": "delete_appointment(appointment_id: int) -> None",
"docstring": null
}
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,39 +0,0 @@
{
"module": "openapi_first.templates.vet_app.main",
"content": {
"path": "openapi_first.templates.vet_app.main",
"docstring": "Application entry point for an OpenAPI-first Veterinary Clinic service.\n\nThis module constructs a FastAPI application exclusively from an\nOpenAPI specification and a handler namespace, without using\ndecorator-driven routing.\n\nAll HTTP routes, methods, request/response schemas, and operation\nbindings are defined in the OpenAPI document referenced by\n``openapi_path``. Python callables defined in the ``routes`` module are\nbound to OpenAPI operations strictly via ``operationId``.\n\nThis module contains no routing logic, persistence concerns, or\nframework configuration beyond application assembly.\n\nDesign guarantees:\n- OpenAPI is the single source of truth\n- No undocumented routes can exist\n- Every OpenAPI operationId must resolve to exactly one handler\n- All contract violations fail at application startup\n\nThis file is intended to be used as the ASGI entry point.\n\nExample:\n uvicorn main:app",
"objects": {
"OpenAPIFirstApp": {
"name": "OpenAPIFirstApp",
"kind": "class",
"path": "openapi_first.templates.vet_app.main.OpenAPIFirstApp",
"signature": "OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)",
"docstring": "FastAPI application enforcing OpenAPI-first design.\n\nArgs:\n openapi_path (str):\n Filesystem path to the OpenAPI 3.x specification file. This\n specification is treated as the authoritative API contract.\n routes_module (ModuleType):\n Python module containing handler functions whose names correspond\n exactly to OpenAPI ``operationId`` values.\n **fastapi_kwargs (Any):\n Additional keyword arguments passed directly to\n ``fastapi.FastAPI`` (e.g., title, version, middleware, lifespan\n handlers).\n\nRaises:\n OpenAPIFirstError:\n If the OpenAPI specification is invalid, or if any declared\n ``operationId`` does not have a corresponding handler function.\n\nNotes:\n **Responsibilities:**\n\n - `OpenAPIFirstApp` subclasses `FastAPI` and replaces manual route\n registration with OpenAPI-driven binding.\n - All routes are derived from the provided OpenAPI specification,\n and each ``operationId`` is mapped to a Python function in the\n supplied routes module.\n - Auth dependencies are auto-injected from the spec's\n ``securitySchemes`` and per-operation ``security`` fields.\n\n **Guarantees:**\n\n - No route can exist without an OpenAPI declaration.\n - No OpenAPI operation can exist without a handler.\n - Swagger UI and ``/openapi.json`` always reflect the provided spec.\n - Handler functions remain framework-agnostic and testable.\n - Auth enforcement is driven entirely by the spec — no manual\n middleware or decorators required.\n\nExample:\n ```python\n from openapi_first.app import OpenAPIFirstApp\n import app.routes as routes\n\n app = OpenAPIFirstApp(\n openapi_path=\"app/openapi.json\",\n routes_module=routes,\n title=\"Example Service\",\n )\n ```",
"members": {
"openapi": {
"name": "openapi",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.main.OpenAPIFirstApp.openapi",
"signature": null,
"docstring": null
}
}
},
"lifespan": {
"name": "lifespan",
"kind": "function",
"path": "openapi_first.templates.vet_app.main.lifespan",
"signature": "lifespan(app)",
"docstring": null
},
"app": {
"name": "app",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.main.app",
"signature": null,
"docstring": null
}
}
}
}

View File

@@ -1,639 +0,0 @@
{
"module": "openapi_first.templates.vet_app.models",
"content": {
"path": "openapi_first.templates.vet_app.models",
"docstring": null,
"objects": {
"Metadata": {
"name": "Metadata",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Metadata",
"signature": null,
"docstring": null,
"members": {
"createdOn": {
"name": "createdOn",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Metadata.createdOn",
"signature": null,
"docstring": null
},
"updatedOn": {
"name": "updatedOn",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Metadata.updatedOn",
"signature": null,
"docstring": null
}
}
},
"ParentBase": {
"name": "ParentBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.ParentBase",
"signature": null,
"docstring": null,
"members": {
"name": {
"name": "name",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ParentBase.name",
"signature": null,
"docstring": null
},
"email": {
"name": "email",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ParentBase.email",
"signature": null,
"docstring": null
},
"phone": {
"name": "phone",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ParentBase.phone",
"signature": null,
"docstring": null
},
"metadata": {
"name": "metadata",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ParentBase.metadata",
"signature": null,
"docstring": null
}
}
},
"ParentCreate": {
"name": "ParentCreate",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.ParentCreate",
"signature": null,
"docstring": null
},
"Parent": {
"name": "Parent",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Parent",
"signature": null,
"docstring": null,
"members": {
"id": {
"name": "id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Parent.id",
"signature": null,
"docstring": null
}
}
},
"VetBase": {
"name": "VetBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.VetBase",
"signature": null,
"docstring": null,
"members": {
"name": {
"name": "name",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VetBase.name",
"signature": null,
"docstring": null
},
"specialty": {
"name": "specialty",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VetBase.specialty",
"signature": null,
"docstring": null
},
"email": {
"name": "email",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VetBase.email",
"signature": null,
"docstring": null
},
"phone": {
"name": "phone",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VetBase.phone",
"signature": null,
"docstring": null
},
"metadata": {
"name": "metadata",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VetBase.metadata",
"signature": null,
"docstring": null
}
}
},
"VetCreate": {
"name": "VetCreate",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.VetCreate",
"signature": null,
"docstring": null
},
"Vet": {
"name": "Vet",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Vet",
"signature": null,
"docstring": null,
"members": {
"id": {
"name": "id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Vet.id",
"signature": null,
"docstring": null
}
}
},
"ProcedureNoteBase": {
"name": "ProcedureNoteBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.ProcedureNoteBase",
"signature": null,
"docstring": null,
"members": {
"summary": {
"name": "summary",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ProcedureNoteBase.summary",
"signature": null,
"docstring": null
},
"details": {
"name": "details",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ProcedureNoteBase.details",
"signature": null,
"docstring": null
}
}
},
"BasicNote": {
"name": "BasicNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.BasicNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.BasicNote.noteType",
"signature": null,
"docstring": null
}
}
},
"HeartRateNote": {
"name": "HeartRateNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.HeartRateNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.HeartRateNote.noteType",
"signature": null,
"docstring": null
},
"bpm": {
"name": "bpm",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.HeartRateNote.bpm",
"signature": null,
"docstring": null
}
}
},
"DentalNote": {
"name": "DentalNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.DentalNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.DentalNote.noteType",
"signature": null,
"docstring": null
},
"procedureType": {
"name": "procedureType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.DentalNote.procedureType",
"signature": null,
"docstring": null
},
"teeth": {
"name": "teeth",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.DentalNote.teeth",
"signature": null,
"docstring": null
}
}
},
"VaccineNote": {
"name": "VaccineNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.VaccineNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VaccineNote.noteType",
"signature": null,
"docstring": null
},
"medicine": {
"name": "medicine",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VaccineNote.medicine",
"signature": null,
"docstring": null
},
"leg": {
"name": "leg",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.VaccineNote.leg",
"signature": null,
"docstring": null
}
}
},
"PreOpNote": {
"name": "PreOpNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.PreOpNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PreOpNote.noteType",
"signature": null,
"docstring": null
},
"heartRate": {
"name": "heartRate",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PreOpNote.heartRate",
"signature": null,
"docstring": null
},
"temperature": {
"name": "temperature",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PreOpNote.temperature",
"signature": null,
"docstring": null
}
}
},
"SurgeryNote": {
"name": "SurgeryNote",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.SurgeryNote",
"signature": null,
"docstring": null,
"members": {
"noteType": {
"name": "noteType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.SurgeryNote.noteType",
"signature": null,
"docstring": null
},
"surgeryType": {
"name": "surgeryType",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.SurgeryNote.surgeryType",
"signature": null,
"docstring": null
},
"complications": {
"name": "complications",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.SurgeryNote.complications",
"signature": null,
"docstring": null
}
}
},
"ProcedureNotes": {
"name": "ProcedureNotes",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.ProcedureNotes",
"signature": null,
"docstring": null
},
"Procedure": {
"name": "Procedure",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Procedure",
"signature": null,
"docstring": null,
"members": {
"name": {
"name": "name",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Procedure.name",
"signature": null,
"docstring": null
},
"description": {
"name": "description",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Procedure.description",
"signature": null,
"docstring": null
},
"cost": {
"name": "cost",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Procedure.cost",
"signature": null,
"docstring": null
},
"notes": {
"name": "notes",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Procedure.notes",
"signature": null,
"docstring": null
}
}
},
"TreatmentBase": {
"name": "TreatmentBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.TreatmentBase",
"signature": null,
"docstring": null,
"members": {
"label": {
"name": "label",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.TreatmentBase.label",
"signature": null,
"docstring": null
},
"description": {
"name": "description",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.TreatmentBase.description",
"signature": null,
"docstring": null
},
"metadata": {
"name": "metadata",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.TreatmentBase.metadata",
"signature": null,
"docstring": null
}
}
},
"TreatmentCreate": {
"name": "TreatmentCreate",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.TreatmentCreate",
"signature": null,
"docstring": null
},
"Treatment": {
"name": "Treatment",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Treatment",
"signature": null,
"docstring": null,
"members": {
"id": {
"name": "id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Treatment.id",
"signature": null,
"docstring": null
}
}
},
"PetBase": {
"name": "PetBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.PetBase",
"signature": null,
"docstring": null,
"members": {
"name": {
"name": "name",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.name",
"signature": null,
"docstring": null
},
"species": {
"name": "species",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.species",
"signature": null,
"docstring": null
},
"age": {
"name": "age",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.age",
"signature": null,
"docstring": null
},
"weight": {
"name": "weight",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.weight",
"signature": null,
"docstring": null
},
"birthDate": {
"name": "birthDate",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.birthDate",
"signature": null,
"docstring": null
},
"photo": {
"name": "photo",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.photo",
"signature": null,
"docstring": null
},
"metadata": {
"name": "metadata",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetBase.metadata",
"signature": null,
"docstring": null
}
}
},
"PetCreate": {
"name": "PetCreate",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.PetCreate",
"signature": null,
"docstring": null,
"members": {
"parent_ids": {
"name": "parent_ids",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.PetCreate.parent_ids",
"signature": null,
"docstring": null
}
}
},
"Pet": {
"name": "Pet",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Pet",
"signature": null,
"docstring": null,
"members": {
"id": {
"name": "id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Pet.id",
"signature": null,
"docstring": null
},
"parents": {
"name": "parents",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Pet.parents",
"signature": null,
"docstring": null
}
}
},
"AppointmentBase": {
"name": "AppointmentBase",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.AppointmentBase",
"signature": null,
"docstring": null,
"members": {
"date": {
"name": "date",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentBase.date",
"signature": null,
"docstring": null
},
"notes": {
"name": "notes",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentBase.notes",
"signature": null,
"docstring": null
},
"procedures": {
"name": "procedures",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentBase.procedures",
"signature": null,
"docstring": null
},
"metadata": {
"name": "metadata",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentBase.metadata",
"signature": null,
"docstring": null
}
}
},
"AppointmentCreate": {
"name": "AppointmentCreate",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.AppointmentCreate",
"signature": null,
"docstring": null,
"members": {
"pet_id": {
"name": "pet_id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentCreate.pet_id",
"signature": null,
"docstring": null
},
"vet_id": {
"name": "vet_id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentCreate.vet_id",
"signature": null,
"docstring": null
},
"treatment_id": {
"name": "treatment_id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.AppointmentCreate.treatment_id",
"signature": null,
"docstring": null
}
}
},
"Appointment": {
"name": "Appointment",
"kind": "class",
"path": "openapi_first.templates.vet_app.models.Appointment",
"signature": null,
"docstring": null,
"members": {
"id": {
"name": "id",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Appointment.id",
"signature": null,
"docstring": null
},
"pet": {
"name": "pet",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Appointment.pet",
"signature": null,
"docstring": null
},
"vet": {
"name": "vet",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Appointment.vet",
"signature": null,
"docstring": null
},
"treatment": {
"name": "treatment",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.models.Appointment.treatment",
"signature": null,
"docstring": null
}
}
}
}
}
}

View File

@@ -1,198 +0,0 @@
{
"module": "openapi_first.templates.vet_app.routes",
"content": {
"path": "openapi_first.templates.vet_app.routes",
"docstring": "Veterinary Clinic route handlers bound via OpenAPI operationId.\n\nHandlers explicitly control HTTP response status codes to ensure runtime\nbehavior matches the OpenAPI contract. Domain models defined using\nPydantic are used for request and response payloads.\n\nNo routing decorators, path definitions, or implicit framework behavior\nappear in this module. All routing, HTTP methods, and schemas are defined\nin the OpenAPI specification.",
"objects": {
"list_parents": {
"name": "list_parents",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.list_parents",
"signature": "list_parents(limit: int = 20, offset: int = 0) -> dict",
"docstring": "List parents (paginated).\n\nParameters\n----------\nlimit : int\n Maximum number of records to return.\noffset : int\n Number of records to skip.\n\nReturns\n-------\ndict\n Paginated response with ``total`` and ``items``."
},
"create_parent": {
"name": "create_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.create_parent",
"signature": "create_parent(payload: ParentCreate, response: Response) -> Parent",
"docstring": "Create a parent.\n\nParameters\n----------\npayload : ParentCreate\n Parent data excluding the ``id`` field.\nresponse : Response\n Response object used to set the HTTP status code.\n\nReturns\n-------\nParent\n The newly created parent."
},
"get_parent": {
"name": "get_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.get_parent",
"signature": "get_parent(id: int) -> Parent",
"docstring": "Retrieve a single parent by ID.\n\nParameters\n----------\nid : int\n Identifier of the parent.\n\nReturns\n-------\nParent\n The requested parent.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
},
"update_parent": {
"name": "update_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.update_parent",
"signature": "update_parent(id: int, payload: ParentCreate) -> Parent",
"docstring": "Update an existing parent.\n\nParameters\n----------\nid : int\n Identifier of the parent.\npayload : ParentCreate\n Updated parent data.\n\nReturns\n-------\nParent\n The updated parent.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
},
"delete_parent": {
"name": "delete_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.delete_parent",
"signature": "delete_parent(id: int, response: Response) -> None",
"docstring": "Delete an existing parent.\n\nParameters\n----------\nid : int\n Identifier of the parent.\nresponse : Response\n Response object used to set the HTTP status code.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
},
"list_vets": {
"name": "list_vets",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.list_vets",
"signature": "list_vets(limit: int = 20, offset: int = 0)",
"docstring": "List vets (paginated)."
},
"create_vet": {
"name": "create_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.create_vet",
"signature": "create_vet(payload: VetCreate, response: Response)",
"docstring": "Create a vet."
},
"get_vet": {
"name": "get_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.get_vet",
"signature": "get_vet(id: int)",
"docstring": "Retrieve a single vet by ID."
},
"update_vet": {
"name": "update_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.update_vet",
"signature": "update_vet(id: int, payload: VetCreate)",
"docstring": "Update an existing vet."
},
"delete_vet": {
"name": "delete_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.delete_vet",
"signature": "delete_vet(id: int, response: Response)",
"docstring": "Delete an existing vet."
},
"list_treatments": {
"name": "list_treatments",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.list_treatments",
"signature": "list_treatments() -> list[Treatment]",
"docstring": "List treatments (catalogue).\n\nReturns\n-------\nlist[Treatment]\n A list of treatment domain objects."
},
"create_treatment": {
"name": "create_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.create_treatment",
"signature": "create_treatment(payload: TreatmentCreate, response: Response)",
"docstring": "Add a treatment (admin only)."
},
"get_treatment": {
"name": "get_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.get_treatment",
"signature": "get_treatment(id: int)",
"docstring": "Retrieve a single treatment by ID."
},
"update_treatment": {
"name": "update_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.update_treatment",
"signature": "update_treatment(id: int, payload: TreatmentCreate)",
"docstring": "Update an existing treatment."
},
"delete_treatment": {
"name": "delete_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.delete_treatment",
"signature": "delete_treatment(id: int, response: Response)",
"docstring": "Delete an existing treatment."
},
"list_pets": {
"name": "list_pets",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.list_pets",
"signature": "list_pets(limit: int = 20, offset: int = 0)",
"docstring": "List pets (paginated)."
},
"create_pet": {
"name": "create_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.create_pet",
"signature": "create_pet(payload: PetCreate, response: Response)",
"docstring": "Create a pet."
},
"get_pet": {
"name": "get_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.get_pet",
"signature": "get_pet(id: int)",
"docstring": "Retrieve a single pet by ID."
},
"update_pet": {
"name": "update_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.update_pet",
"signature": "update_pet(id: int, payload: PetCreate)",
"docstring": "Update an existing pet."
},
"delete_pet": {
"name": "delete_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.delete_pet",
"signature": "delete_pet(id: int, response: Response)",
"docstring": "Delete an existing pet."
},
"upload_pet_photo": {
"name": "upload_pet_photo",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.upload_pet_photo",
"signature": "upload_pet_photo(id: int, file: UploadFile) -> dict",
"docstring": "Upload a pet photo.\n\nParameters\n----------\nid : int\n Identifier of the pet.\nfile : UploadFile\n Image file to upload.\n\nReturns\n-------\ndict\n A confirmation with the pet ID."
},
"list_appointments": {
"name": "list_appointments",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.list_appointments",
"signature": "list_appointments(limit: int = 20, offset: int = 0, date: str = None, vet: int = None, pet: int = None)",
"docstring": "List appointments (paginated, filterable)."
},
"create_appointment": {
"name": "create_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.create_appointment",
"signature": "create_appointment(payload: AppointmentCreate, response: Response)",
"docstring": "Create an appointment."
},
"get_appointment": {
"name": "get_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.get_appointment",
"signature": "get_appointment(id: int)",
"docstring": "Retrieve a single appointment by ID."
},
"update_appointment": {
"name": "update_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.update_appointment",
"signature": "update_appointment(id: int, payload: AppointmentCreate)",
"docstring": "Update an existing appointment."
},
"delete_appointment": {
"name": "delete_appointment",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.delete_appointment",
"signature": "delete_appointment(id: int, response: Response)",
"docstring": "Delete an existing appointment."
},
"stream_actions": {
"name": "stream_actions",
"kind": "function",
"path": "openapi_first.templates.vet_app.routes.stream_actions",
"signature": "stream_actions(id: int)",
"docstring": "Stream animal actions via SSE, scoped to a pet's species."
}
}
}
}

View File

@@ -1,23 +0,0 @@
{
"module": "openapi_first.templates.vet_app.sse",
"content": {
"path": "openapi_first.templates.vet_app.sse",
"docstring": null,
"objects": {
"subscribe": {
"name": "subscribe",
"kind": "function",
"path": "openapi_first.templates.vet_app.sse.subscribe",
"signature": "subscribe(pet_id: int, species: str) -> asyncio.Queue",
"docstring": null
},
"unsubscribe": {
"name": "unsubscribe",
"kind": "function",
"path": "openapi_first.templates.vet_app.sse.unsubscribe",
"signature": "unsubscribe(pet_id: int, q: asyncio.Queue)",
"docstring": null
}
}
}
}

View File

@@ -1,165 +0,0 @@
{
"module": "openapi_first.templates.vet_app.test_vet_app",
"content": {
"path": "openapi_first.templates.vet_app.test_vet_app",
"docstring": "End-to-end tests for the OpenAPI-first Veterinary Clinic example app.\n\nThese tests validate that all CRUD operations behave correctly\nagainst the in-memory mock data store using Pydantic models.",
"objects": {
"load_openapi": {
"name": "load_openapi",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.load_openapi",
"signature": "load_openapi(path: str | Path)",
"docstring": "Load and validate an OpenAPI 3.x specification from disk.\n\nArgs:\n path (str | Path):\n Filesystem path to an OpenAPI specification file. Supported\n extensions: `.json`, `.yaml`, `.yml`.\n\nReturns:\n dict[str, Any]:\n Parsed and validated OpenAPI specification.\n\nRaises:\n OpenAPISpecLoadError:\n If the file does not exist, cannot be parsed, or fails OpenAPI\n schema validation.\n\nNotes:\n **Guarantees:**\n\n - The specification is parsed based on file extension and validated\n using a strict OpenAPI schema validator.\n - Any error results in an immediate exception, preventing\n application startup."
},
"OpenAPIClient": {
"name": "OpenAPIClient",
"kind": "class",
"path": "openapi_first.templates.vet_app.test_vet_app.OpenAPIClient",
"signature": "OpenAPIClient(spec: dict[str, Any], base_url: str | None = None, client: httpx.Client | None = None)",
"docstring": "OpenAPI-first HTTP client (`httpx`-based).\n\nArgs:\n spec (dict[str, Any]):\n Parsed OpenAPI 3.x specification.\n base_url (str | None):\n Base URL of the target service. If omitted, the first entry in the\n OpenAPI `servers` list is used.\n client (httpx.Client | None):\n Optional preconfigured httpx client instance.\n\nRaises:\n OpenAPIClientError:\n If no servers are defined, spec has no paths, operationIds are\n missing/duplicate, or required parameters are missing.\n\nNotes:\n **Responsibilities:**\n\n - This client derives all callable methods directly from an\n OpenAPI 3.x specification. Each `operationId` becomes a method\n on the client instance.\n\n **Guarantees:**\n\n - One callable per `operationId`.\n - Explicit parameters (path, query, headers, body).\n - No implicit schema inference or mutation.\n - Returns raw `httpx.Response` objects.\n - No response validation or deserialization.\n\nExample:\n ```python\n from openapi_first import loader, client\n\n spec = loader.load_openapi(\"openapi.yaml\")\n\n api = client.OpenAPIClient(\n spec=spec,\n base_url=\"http://localhost:8000\",\n )\n\n # Call operationId: getUser\n response = api.getUser(\n path_params={\"user_id\": 123}\n )\n\n print(response.status_code)\n print(response.json())\n ```",
"members": {
"spec": {
"name": "spec",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.OpenAPIClient.spec",
"signature": null,
"docstring": null
},
"base_url": {
"name": "base_url",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.OpenAPIClient.base_url",
"signature": null,
"docstring": null
},
"client": {
"name": "client",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.OpenAPIClient.client",
"signature": null,
"docstring": null
},
"operations": {
"name": "operations",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.OpenAPIClient.operations",
"signature": "operations()",
"docstring": null
}
}
},
"test_client": {
"name": "test_client",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.test_client",
"signature": null,
"docstring": null
},
"spec": {
"name": "spec",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.spec",
"signature": null,
"docstring": null
},
"client": {
"name": "client",
"kind": "attribute",
"path": "openapi_first.templates.vet_app.test_vet_app.client",
"signature": null,
"docstring": null
},
"test_list_parents": {
"name": "test_list_parents",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_list_parents",
"signature": "test_list_parents()",
"docstring": "List parents returns paginated response."
},
"test_create_parent": {
"name": "test_create_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_create_parent",
"signature": "test_create_parent()",
"docstring": "Creating a parent returns 201 with the created entity."
},
"test_get_parent": {
"name": "test_get_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_get_parent",
"signature": "test_get_parent()",
"docstring": "Get parent by ID returns the entity."
},
"test_update_parent": {
"name": "test_update_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_update_parent",
"signature": "test_update_parent()",
"docstring": "Update parent replaces its values."
},
"test_delete_parent": {
"name": "test_delete_parent",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_delete_parent",
"signature": "test_delete_parent()",
"docstring": "Delete parent returns 204 and removes the entity."
},
"test_list_vets": {
"name": "test_list_vets",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_list_vets",
"signature": "test_list_vets()",
"docstring": "List vets returns paginated response."
},
"test_create_vet": {
"name": "test_create_vet",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_create_vet",
"signature": "test_create_vet()",
"docstring": "Creating a vet returns 201."
},
"test_list_treatments": {
"name": "test_list_treatments",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_list_treatments",
"signature": "test_list_treatments()",
"docstring": "List treatments returns an array."
},
"test_create_treatment": {
"name": "test_create_treatment",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_create_treatment",
"signature": "test_create_treatment()",
"docstring": "Creating a treatment returns 201."
},
"test_create_pet": {
"name": "test_create_pet",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_create_pet",
"signature": "test_create_pet()",
"docstring": "Creating a pet links FK references."
},
"test_upload_pet_photo": {
"name": "test_upload_pet_photo",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_upload_pet_photo",
"signature": "test_upload_pet_photo()",
"docstring": "Upload pet photo returns 200."
},
"test_list_appointments": {
"name": "test_list_appointments",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_list_appointments",
"signature": "test_list_appointments()",
"docstring": "List appointments returns paginated response with filter params."
},
"test_full_appointment_lifecycle": {
"name": "test_full_appointment_lifecycle",
"kind": "function",
"path": "openapi_first.templates.vet_app.test_vet_app.test_full_appointment_lifecycle",
"signature": "test_full_appointment_lifecycle()",
"docstring": "Create a parent, vet, treatment, pet, then an appointment."
}
}
}
}

View File

@@ -1,130 +0,0 @@
[
{
"module": "openapi_first",
"resource": "docs://modules/openapi_first"
},
{
"module": "openapi_first.app",
"resource": "docs://modules/openapi_first.app"
},
{
"module": "openapi_first.binder",
"resource": "docs://modules/openapi_first.binder"
},
{
"module": "openapi_first.cli",
"resource": "docs://modules/openapi_first.cli"
},
{
"module": "openapi_first.client",
"resource": "docs://modules/openapi_first.client"
},
{
"module": "openapi_first.codegen",
"resource": "docs://modules/openapi_first.codegen"
},
{
"module": "openapi_first.codegen_routes",
"resource": "docs://modules/openapi_first.codegen_routes"
},
{
"module": "openapi_first.errors",
"resource": "docs://modules/openapi_first.errors"
},
{
"module": "openapi_first.loader",
"resource": "docs://modules/openapi_first.loader"
},
{
"module": "openapi_first.security",
"resource": "docs://modules/openapi_first.security"
},
{
"module": "openapi_first.templates",
"resource": "docs://modules/openapi_first.templates"
},
{
"module": "openapi_first.templates.crud_app",
"resource": "docs://modules/openapi_first.templates.crud_app"
},
{
"module": "openapi_first.templates.crud_app.data",
"resource": "docs://modules/openapi_first.templates.crud_app.data"
},
{
"module": "openapi_first.templates.crud_app.main",
"resource": "docs://modules/openapi_first.templates.crud_app.main"
},
{
"module": "openapi_first.templates.crud_app.routes",
"resource": "docs://modules/openapi_first.templates.crud_app.routes"
},
{
"module": "openapi_first.templates.crud_app.test_crud_app",
"resource": "docs://modules/openapi_first.templates.crud_app.test_crud_app"
},
{
"module": "openapi_first.templates.health_app",
"resource": "docs://modules/openapi_first.templates.health_app"
},
{
"module": "openapi_first.templates.health_app.main",
"resource": "docs://modules/openapi_first.templates.health_app.main"
},
{
"module": "openapi_first.templates.health_app.routes",
"resource": "docs://modules/openapi_first.templates.health_app.routes"
},
{
"module": "openapi_first.templates.model_app",
"resource": "docs://modules/openapi_first.templates.model_app"
},
{
"module": "openapi_first.templates.model_app.data",
"resource": "docs://modules/openapi_first.templates.model_app.data"
},
{
"module": "openapi_first.templates.model_app.main",
"resource": "docs://modules/openapi_first.templates.model_app.main"
},
{
"module": "openapi_first.templates.model_app.models",
"resource": "docs://modules/openapi_first.templates.model_app.models"
},
{
"module": "openapi_first.templates.model_app.routes",
"resource": "docs://modules/openapi_first.templates.model_app.routes"
},
{
"module": "openapi_first.templates.model_app.test_model_app",
"resource": "docs://modules/openapi_first.templates.model_app.test_model_app"
},
{
"module": "openapi_first.templates.vet_app",
"resource": "docs://modules/openapi_first.templates.vet_app"
},
{
"module": "openapi_first.templates.vet_app.data",
"resource": "docs://modules/openapi_first.templates.vet_app.data"
},
{
"module": "openapi_first.templates.vet_app.main",
"resource": "docs://modules/openapi_first.templates.vet_app.main"
},
{
"module": "openapi_first.templates.vet_app.models",
"resource": "docs://modules/openapi_first.templates.vet_app.models"
},
{
"module": "openapi_first.templates.vet_app.routes",
"resource": "docs://modules/openapi_first.templates.vet_app.routes"
},
{
"module": "openapi_first.templates.vet_app.sse",
"resource": "docs://modules/openapi_first.templates.vet_app.sse"
},
{
"module": "openapi_first.templates.vet_app.test_vet_app",
"resource": "docs://modules/openapi_first.templates.vet_app.test_vet_app"
}
]

View File

@@ -1,74 +0,0 @@
theme:
name: material
palette:
scheme: slate
primary: blue grey
accent: teal
font:
text: Roboto
code: JetBrains Mono
features:
- navigation.sections
- navigation.expand
- navigation.top
- navigation.instant
- navigation.tracking
- navigation.indexes
- content.code.copy
- content.code.annotate
- content.tabs.link
- content.action.edit
- search.highlight
- search.share
- search.suggest
- navigation.tabs
- toc.integrate
- header.autohide
- announce.dismiss
- footer.social
- content.code.select
- content.code.line_numbers
- content.tooltips
icon:
logo: material/api
repo: fontawesome/brands/github
markdown_extensions:
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.details
- pymdownx.highlight:
linenums: true
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- footnotes
- pymdownx.caret
- pymdownx.tilde
- pymdownx.mark
extra_css:
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
plugins:
- search
site_name: openapi_first
docs_dir: wiki
site_dir: ../site/wiki
nav:
- Home: index.md
- Overview: 01_overview.md
- Components: 02_components.md
- Use Cases:
- Quickstart: 03_use_cases/01_quickstart.md
- Templates: 03_use_cases/02_templates.md
- Client: 03_use_cases/03_client.md
- Codegen: 03_use_cases/04_codegen.md
- Design: 04_design.md
- Security: 05_security.md
- Error Handling: 06_error_handling.md
- Testing: 07_testing.md

View File

@@ -1,157 +0,0 @@
# Overview — The OpenAPI-First Mental Model
`openapi-first` inverts the usual FastAPI workflow. Instead of decorating routes in code and letting FastAPI *invent* an OpenAPI document for you, you write **one OpenAPI document first** and let the library assemble both the application **and** the client from it. The spec is the contract; code is the implementation.
---
## 🧠 1. The Mental Model
### 1.1 One source of truth
Your OpenAPI document (`openapi.yaml` or `openapi.json`) is the **single authoritative contract**:
```yaml
paths:
/health:
get:
operationId: get_health
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
```
Every route, method, parameter, schema, and security requirement lives **here** — and only here. Code never declares routes.
### 1.2 `operationId` is the binding key
The only bridge between the spec and your Python code is the `operationId`. Each operation maps, **by name**, to exactly one plain callable:
```python
# routes.py
def get_health():
"""Health check operation handler."""
return {"status": "ok"}
```
`openapi_first` resolves `operationId: get_health` → `routes.get_health` and registers the route. **No decorators, no `@app.get`, no routing metadata in code.**
Guarantees this binding provides:
- 🚫 No undocumented route can exist — every route *must* be in the spec
- 🚫 No spec operation can go unhandled — every `operationId` *must* resolve at startup
- 🔒 No auth can be bypassed — security is injected from `securitySchemes` + per-operation `security`, spec-driven
- 🧱 No drift possible — the server and client are built from the *same* document
### 1.3 Fail-fast by design
Contract violations are detected **at application startup** (or client construction), never silently at request time:
| What goes wrong | When it fails |
|------------------------------------------|----------------------|
| Invalid / unloadable spec | `load_openapi` at startup |
| Spec fails OpenAPI 3.x validation | `load_openapi` at startup |
| `operationId` missing a handler | `bind_routes` at startup |
| Operation declared but no `operationId` | `bind_routes` at startup |
| Missing / duplicate `operationId` in client | `OpenAPIClient(...)` construction |
---
## ⚙️ 2. What It Looks Like
### 2.1 Scaffold an application
```bash
openapi-first scaffold health_app my-health-service
openapi-first scaffold --list
```
`scaffold` copies a bundled template (verbatim — no code generation, no mutation) into a directory of your choice.
### 2.2 Bootstrap the server
```python
# main.py
from openapi_first.app import OpenAPIFirstApp
import routes
app = OpenAPIFirstApp(
openapi_path="openapi.yaml",
routes_module=routes,
title="My Service",
)
```
Run with your FastAPI-compatible server (ASGI):
```bash
uvicorn main:app --reload
```
FastAPI itself drives the server; every route, response model, and security dependency comes from the spec. `/openapi.json` and Swagger UI always reflect the spec, byte-for-byte.
### 2.3 Talk to it with the client
```python
# client-side
from openapi_first.loader import load_openapi
from openapi_first.client import OpenAPIClient
spec = load_openapi("openapi.yaml")
client = OpenAPIClient(spec)
response = client.get_health() # operationId-driven call
print(response.status_code) # 200
print(response.json()) # {"status": "ok"}
```
`OpenAPIClient` builds one callable per `operationId` from the *same* spec, so the client can never drift from the server.
---
## 🧩 3. Where Things Live
| Concern | Module |
|------------------------|---------------------|
| Load + validate spec | `openapi_first.loader` |
| Boot FastAPI app | `openapi_first.app` |
| Bind routes by opId | `openapi_first.binder` |
| HTTP client | `openapi_first.client` |
| Error hierarchy | `openapi_first.errors` |
| Security dependencies | `openapi_first.security` |
| Pydantic model codegen | `openapi_first.codegen` (uses `datamodel_code_generator`) |
| Route stub codegen | `openapi_first.codegen_routes` |
| Models / routes CLI | `openapi_first.cli` |
| Bundled templates | `openapi_first.templates` |
Jurisdictions:
- `loader`, `app`, `binder`, `client`, `errors`, `security` are the **library API surface** — stable, tested, documented.
- `templates` are **copyable scaffolds** — not part of the library API; excluded from lint/format/type gates, never imported at runtime.
---
## 📄 4. The Non-Goals
`openapi-first` deliberately does **not**:
- Parse decorators to generate an OpenAPI schema (that's default FastAPI behavior — the inverse)
- Generate models from code at runtime (only at **build time** via CLI, from spec → Pydantic)
- Validate request/response bodies against the spec at runtime (contract is enforced at startup / client construction; FastAPI + Pydantic handle runtime coercion)
- Invent routing from path conventions — `operationId` binding only
- Ship a production feature set in the bundled templates (they're demos/scaffolds: in-memory stores, no concurrency, no auth configured)
---
## 🧭 5. Path Forward
New here? Start with [01 – Quickstart](03_use_cases/01_quickstart.md). Want to copy a runnable app? Jump to [02 – Templates](03_use_cases/02_templates.md). Digging into internals? See [Design](04_design.md).
---
## Related
- [01 – Quickstart](03_use_cases/01_quickstart.md) · [02 – Components](02_components.md) · [01 – Overview](01_overview.md)

View File

@@ -1,208 +0,0 @@
# Components — What Ships in the Box
The library is deliberately small. Everything you need to run an OpenAPI-first service and talk to it with a strict client fits in a handful of modules.
---
## 🗂️ 1. Module Map
| Module | Responsibility | Import |
|---------------------------------|---------------------------------------------------|--------|
| `openapi_first.loader` | Load/validate the spec, resolve `{ENV_VAR}` | `load_openapi` |
| `openapi_first.app` | OpenAPI-first FastAPI application bootstrap | `OpenAPIFirstApp` |
| `openapi_first.binder` | Spec → route binding via `operationId` | `bind_routes` |
| `openapi_first.client` | `operationId`-driven HTTP client | `OpenAPIClient` |
| `openapi_first.errors` | Explicit error hierarchy | `OpenAPIFirstError`, `OpenAPIClientError`, `MissingOperationHandler` |
| `openapi_first.security` | Security-dependency construction from the spec | `parse_security_schemes`, `make_security_dependencies` |
| `openapi_first.codegen` | Pydantic model generation (build-time) | `generate_models` |
| `openapi_first.codegen_routes` | Route-handler stub generation (build-time) | `generate_routes` |
| `openapi_first.cli` | `scaffold` / `models` / `routes` command surface | CLI entry point |
| `openapi_first.templates` | Copyable application templates (NOT library API) | `openapi-first scaffold` |
---
## ⚙️ 2. `loader` — Load & Validate
`load_openapi(path: str | Path) -> dict[str, Any]` (in `openapi_first/loader.py`).
`loader.py` ensures a spec is real, readable, parseable, and schema-valid *before* anything else runs — a golden rule of fail-fast.
```python
from openapi_first.loader import load_openapi
spec = load_openapi("openapi.yaml")
```
Behavior:
- Accepts `.json`, `.yaml`, `.yml` (parsed by extension).
- Runs strict OpenAPI 3.x validation (`openapi-spec-validator`) at load time.
- Raises `OpenAPISpecLoadError` on: missing file, unparseable content, or spec-validation failure.
- Does **not** modify, coerce, or "fix" the spec — it's a read-only gate.
**Env-var resolution** lives at the *security* layer rather than the loader (see [Security](05_security.md)).
---
## 🧬 3. `app` — The Application Bootstrap
`OpenAPIFirstApp` (in `openapi_first/app.py`) is a FastAPI subclass that replaces manual route registration with OpenAPI-driven binding.
```python
from openapi_first.app import OpenAPIFirstApp
import routes
app = OpenAPIFirstApp(
openapi_path="openapi.yaml",
routes_module=routes,
title="My Service",
)
```
**Startup pipeline (fail-fast, in this order):**
1. **Load** the spec (`.yaml`/`.json`).
2. **Validate** it against OpenAPI 3.x schema.
3. **Parse** `securitySchemes` and per-operation `security`.
4. **Build** per-route security dependencies.
5. **Bind** every path/method → handler by `operationId`; a missing handler, a missing `operationId` on a declared operation, or an unbound operation raises at startup.
**Guarantees:**
- Every route has a spec declaration (no undocumented routes).
- Every spec operation has a handler (no unhandled operations).
- Auth enforcement is spec-driven, not hand-wired.
- `/openapi.json` + Swagger UI always reflect the provided spec.
Keyword arguments beyond `openapi_path` / `routes_module` pass straight through to `fastapi.FastAPI` (it's a subclass — `title`, `version`, middleware, lifespan, … all work).
---
## 🔗 4. `binder` — Spec → Route Binding
`bind_routes(app, spec, routes_module, security_deps=None) -> None` (in `openapi_first/binder.py`).
This is the heart of the OpenAPI-first guarantee. For each `path` + HTTP method in the spec:
1. Reads the operation's `operationId`.
2. Looks up `routes_module.<operationId>` — a **plain callable**.
3. Registers a FastAPI `APIRoute` bound to that handler, injecting `Depends(...)` for any matching security requirements.
Failures are explicit and early:
| Condition | Raised |
|---------------------------------------|---------------------------------------|
| No `operationId` on an operation | `MissingOperationHandler` |
| `operationId` has no handler function | `MissingOperationHandler` |
| A path/method declared but unbound | `MissingOperationHandler` |
Handlers stay framework-agnostic: they're plain functions `(payload, id, response)` named after `operationId`s — no decorators, no routing metadata.
---
## 📡 5. `client` — The Other Side of the Contract
`OpenAPIClient(spec, base_url=None, client=None)` (in `openapi_first/client.py`).
The same spec that builds the server builds its client — one callable per `operationId`, keyed by name:
```python
from openapi_first.loader import load_openapi
from openapi_first.client import OpenAPIClient
spec = load_openapi("openapi.yaml")
client = OpenAPIClient(spec)
response = client.get_health()
response = client.get_user(path_params={"user_id": 1})
response = client.create_user(body={"name": "Ada"})
```
How operations become methods:
- Each `operationId` → a dynamically-built callable on the client.
- **Path parameters** → `path_params={"user_id": 1}`.
- **Request body** → `body={...}` (JSON) or raw content for non-JSON media types.
- **Query/headers** → `query=` / `headers=`.
- Returns the raw `httpx.Response` (no implicit deserialization, no hidden schema inference).
Client-construction guarantees (fail-fast, same philosophy as the app):
- Spec must declare at least one `servers` entry (`base_url` falls back to it).
- Spec must have `paths`.
- Every operation must have a **unique** `operationId`.
- Required params must match the spec at call time.
Construction errors raise `OpenAPIClientError`; request-time errors surface as `httpx` exceptions with `operationId` context.
---
## 💥 6. `errors` — Explicit Error Hierarchy
Everything raised by `openapi-first` derives from `OpenAPIFirstError` (in `openapi_first/errors.py`), so callers can handle first-party failures with a single `except`:
- `OpenAPIFirstError` — base (comparable / aims to be picklable share).
- `OpenAPIClientError` — client-side contract violations.
- `MissingOperationHandler` — spec declares an operation whose handler is missing or unresolvable; carries `path`, `method`, and optional `operationId`.
See [Error Handling](06_error_handling.md) for the full table.
---
## 🛡️ 7. `security` — Auth from the Spec
`security.py` turns an OpenAPI `securitySchemes` section into FastAPI `Depends(...)` objects — **no manual middleware**.
- `parse_security_schemes(spec) -> dict[str, dict]` — collects schemes, resolving `{ENV_VAR}` placeholders.
- `make_security_dependencies(spec, security_schemes) -> dict[str, list[Depends]]` — builds `METHOD:/path` → dependency list from per-operation `security`, falling back to top-level `security`.
Supported scheme types (extensible):
- `type: http, scheme: bearer` — `OpenAPIFirstSecurityDependency(HTTPBearer)`. With `x-introspect-path`/`x-server-url`, it introspects the JWT against an auth service; optionally sets `request.state.user`. Without introspection, it validates token presence and stores it on `request.state.token`.
- API-key style schemes via the same resolution path.
Key properties: resolution is **per-operation**, env placeholders resolve once at startup, and dependencies are injected by `binder` — your handlers never mention security.
---
## 🏭 8. `codegen` & `cli` — Build-Time Tooling
Generation is strictly **build-time** — spec → code, run once by a developer, committed:
### `openapi-first models <spec> -o <file>`
Generates Pydantic models from spec schemas (wraps `datamodel_code_generator`):
```python
# cli path
openapi-first models openapi.yaml -o app/models.py
```
### `openapi-first routes <spec> -o <dir> [--use-models] [--models-module models]`
Generates one `routes_<resource>.py` stub file per resource, with `NotImplementedError` handlers bound to `operationId`s (optionally importing your generated models):
```python
openapi-first routes openapi.yaml -o app/routes --use-models
```
### `openapi-first scaffold <template> [path]`
Copies a bundled application template verbatim (see [Templates](03_use_cases/02_templates.md)).
---
## 🧱 9. `templates` — Copyable Applications
Four bundled, runnable applications live under `openapi_first/templates/`: `health_app`, `crud_app`, `model_app`, and `vet_app`. They are **not** part of the library API — no lint/format/type gates, never imported at runtime. They exist to be copied via:
```bash
openapi-first scaffold <template> [target-dir]
openapi-first scaffold --list
```
---
## 🔗 Related
- [01 – Overview](01_overview.md) · [02 – Templates](03_use_cases/02_templates.md) · [03 – Security](05_security.md) · [04 – Design](04_design.md)

View File

@@ -1,122 +0,0 @@
# Use Case 1: Quickstart — Build Your First OpenAPI-First Service
This guide walks you from an empty directory to a running, contract-driven service in a few minutes, then talks to it with the generated client.
---
## 🛠️ 1. Prerequisites
- Python 3.10+
- `openapi-first` installed (see [Overview](../01_overview.md#installation))
- `pip install "fastapi[standard]"` (or `uvicorn`) to run the app
---
## 📄 2. Write the OpenAPI document
OpenAPI comes first. Create `openapi.yaml`:
```yaml
openapi: 3.0.3
info:
title: Greeting Service
version: 1.0.0
servers:
- url: http://localhost:8000
paths:
/greet/{name}:
get:
operationId: get_greeting
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
"200":
description: A greeting
content:
application/json:
schema:
type: object
properties:
greeting:
type: string
```
Key points: every operation needs `operationId`, and every route must exist *only* here.
---
## 🧑‍💻 3. Write the handlers
Create `routes.py` — plain functions, no decorators, named exactly like the `operationId`s:
```python
# routes.py
def get_greeting(name: str) -> dict:
"""Return a greeting for the given name."""
return {"greeting": f"Hello, {name}!"}
```
If a handler is missing at startup, the app **refuses to boot** (`MissingOperationHandler`) — the fail-fast guarantee catches contract drift immediately.
---
## 🚀 4. Bootstrap the app
Create `main.py`:
```python
# main.py
from openapi_first.app import OpenAPIFirstApp
import routes
app = OpenAPIFirstApp(
openapi_path="openapi.yaml",
routes_module=routes,
title="Greeting Service",
)
```
Run it:
```bash
uvicorn main:app --reload
```
Visit `http://localhost:8000/docs` (Swagger UI) and `http://localhost:8000/openapi.json` — both are generated from *your* spec.
---
## 📡 5. Call it with the client
The same spec builds a strict client:
```python
# client.py
from openapi_first.loader import load_openapi
from openapi_first.client import OpenAPIClient
spec = load_openapi("openapi.yaml")
client = OpenAPIClient(spec)
response = client.get_greeting(path_params={"name": "Ada"})
print(response.status_code) # 200
print(response.json()) # {"greeting": "Hello, Ada!"}
```
---
## 💡 6. Next Steps
- Copy a fuller example: [02 – Templates](02_templates.md)
- Generate models/routes from a bigger spec: [04 – Codegen](04_codegen.md)
- Drive everything from a client: [03 – Client](03_client.md)
---
## Related
- [01 – Overview](../01_overview.md) · [02 – Components](../02_components.md) · [01 – Quickstart](01_quickstart.md)

View File

@@ -1,167 +0,0 @@
# Use Case 2: Templates — Copyable Reference Applications
`openapi-first` ships four runnable, copyable applications under `openapi_first/templates/`. They are **not part of the library API** — they are bundled scaffold examples you copy into your own project and build on.
---
## 🎬 1. What Templates Are
A template is a complete, self-contained OpenAPI-first service:
- A bundled directory inside `openapi_first/templates/<name>/`
- Copyable **verbatim** — no code generation, no mutation — via the CLI
- Each one demonstrates a specific set of OpenAPI-first behaviors and FastAPI features
All templates share the same skeleton:
```
<name>_app/
├── __init__.py # explains the template + how to scaffold it
├── openapi.yaml # the contract (source of truth)
├── main.py # assembles OpenAPIFirstApp from the spec
├── routes.py # operationId-bound handler functions
└── data.py # in-memory data store (demo only)
```
---
## 📋 2. The Four Templates
### 2.1 `health_app` — minimal liveness probe
```bash
openapi-first scaffold health_app
# or into a custom directory:
openapi-first scaffold health_app my-health-service
```
| File | Purpose |
|------|---------|
| `openapi.yaml` | `GET /health` → `operationId: get_health` |
| `routes.py` | `get_health()` returns `{"status": "ok"}` |
| `main.py` | `OpenAPIFirstApp(openapi_path="openapi.yaml", routes_module=routes)` |
**Why it exists:** the absolute minimal OpenAPI-first round trip — one operation, one handler, zero moving parts. The best starting point to internalize the mental model.
**Smoke test:**
```bash
pip install -e .
uvicorn main:app
curl http://localhost:8000/health
# → {"status": "ok"}
```
### 2.2 `crud_app` — dict-based CRUD
```bash
openapi-first scaffold crud_app my-crud-service
```
| File | Purpose |
|------|---------|
| `openapi.yaml` | Full CRUD over `/items` (list/get/create/update/delete) |
| `routes.py` | Handlers bound via `operationId`s `list_items`, `get_item`, `create_item`, `update_item`, `delete_item` |
| `data.py` | In-memory dict store with auto-incrementing `id` |
Behaviors you learn:
- **Explicit status codes** — `create_item`/`delete_item` take `response: Response` and set `201`/`204`; `get_item`/`update_item` raise `HTTPException(404)` on `KeyError`
- **Handlers as plain callables** — no FastAPI decorators, routing comes solely from the spec
- **Mock data store** — `data.py` is a copyable in-memory store, explicitly **not** production-ready
### 2.3 `model_app` — Pydantic model CRUD
```bash
openapi-first scaffold model_app my-model-service
```
| File | Purpose |
|------|---------|
| `openapi.yaml` | Same CRUD surface, schemas reference models |
| `models.py` | Pydantic `Item`, `ItemCreate`, `ItemBase` (request/response models) |
| `routes.py` | Handlers type-annotated with the models; `create_item` sets `201` |
| `data.py` | In-memory store returning real model instances |
Behaviors you learn:
- **Pydantic request/response models** — payloads validated and serialized via FastAPI
- **Same handler contracts** — identical `operationId` set as `crud_app`, so the two are interchangeable
- **Models in the client too** — the same spec drives `OpenAPIClient` body handling
### 2.4 `vet_app` — the full-featured demo
```bash
openapi-first scaffold vet_app my-vet-clinic
```
| File | Purpose |
|------|---------|
| `openapi.yaml` | Five resources (parents, vets, treatments, pets, appointments) + SSE + upload + discriminated unions |
| `models.py` | Pydantic models incl. **discriminated unions** (`noteType` literal fields) |
| `routes.py` | ~20 handlers across all resources, incl. pagination, filtering, photo upload, SSE streaming |
| `sse.py` | Server-Sent Events helper (`StreamingResponse`, per-pet subscriber queues, background `asyncio` workers) |
| `data.py` | Larger in-memory store (parents → vets → treatments → pets → appointments) |
| `main.py` | App + CORS + lifespan example |
Behaviors you learn — the *advanced* tier:
- **Discriminated unions** — `ProcedureNotes` uses `oneOf` + `discriminator.noteType` mapping; Pydantic models use `Literal[...]` discriminator fields
- **SSE streaming** — a `GET /pets/{id}/actions` operation streaming `text/event-stream` via `StreamingResponse` with background task workers
- **File upload** — `UploadFile` handler setting a multi-part body
- **CORS + middleware** — `add_middleware(CORSMiddleware, ...)` alongside the spec-driven setup
- **Response injection** — handlers set `201`/`204` explicitly via injected `Response`
---
## 🚀 3. CLI Reference
```bash
# List available templates
openapi-first scaffold --list
# Copy a template into its default directory (template name, dashes)
openapi-first scaffold health_app
# Copy into a custom target directory
openapi-first scaffold crud_app my-project/crud
```
> **Protip:** `DEFAULT_TEMPLATE` is `health_app`, so `openapi-first scaffold` with no template name scaffolds the health app.
---
## 🧩 4. Anatomy of a Scaffolded Service
After `openapi-first scaffold health_app my-health-service`, your directory contains a drop-in FastAPI service:
```
my-health-service/
├── openapi.yaml # THE contract
├── main.py # `app = OpenAPIFirstApp(openapi_path=..., routes_module=routes)`
└── routes.py # `def get_health(): ...`
```
Run it:
```bash
cd my-health-service
pip install -e .
uvicorn main:app --reload
```
`/docs`, `/openapi.json`, and every declared route now exist — all derived from `openapi.yaml`.
---
## ⚠️ 5. Production Disclaimer
Templates use **in-memory, non-persistent, non-concurrency-safe** data stores. They are learning scaffolds — **not** production references. Swap in a real data layer (SQL/REDIS/object store) the moment you go beyond a demo.
See the `__init__.py` of each template for detailed client examples, CLI examples, and design notes.
---
## Related
- [01 – Quickstart](01_quickstart.md) · [04 – Codegen](04_codegen.md) · [02 – Components](../02_components.md)

View File

@@ -1,156 +0,0 @@
# Use Case 3: The OperationId-Driven Client
`OpenAPIClient` is the other side of the contract. It reads the *same* OpenAPI document the server runs on and exposes one callable per `operationId` — so "client" and "server" are two views of one truth.
---
## 🔍 1. Before You Start
The client is `httpx`-based and returns raw `httpx.Response` objects — no magic deserialization, no hidden schema inference:
- **No** response Pydantic models
- **No** implicit URL construction (path params are explicit)
- **No** hand-written `requests.get(...)` scattered through your code
---
## 🧬 2. Constructing the Client
```python
from openapi_first.loader import load_openapi
from openapi_first.client import OpenAPIClient
spec = load_openapi("openapi.yaml")
client = OpenAPIClient(spec)
```
The base URL comes from the spec's `servers` list (first entry) unless you pass `base_url` explicitly:
```python
client = OpenAPIClient(spec, base_url="https://api.internal.myco/v1")
```
You can also hand over a preconfigured `httpx.Client` (custom transport, TLS, retries):
```python
import httpx
transport = httpx.HTTPTransport(retries=3)
client = OpenAPIClient(
spec,
client=httpx.Client(transport=transport),
)
```
---
## 💥 3. Fail-Fast at Construction
`OpenAPIClient(...)` **raises immediately** if the contract is broken — you find out at startup, not on the first request:
| Violation | Error |
|----------------------------------------|-----------------------------------|
| Spec has no `servers` entry | `OpenAPIClientError` |
| Spec has no `paths` | `OpenAPIClientError` |
| Operation missing `operationId` | `OpenAPIClientError` |
| Duplicate `operationId` | `OpenAPIClientError` |
| Operation references unknown parameters| `OpenAPIClientError` |
Missing *required parameters* fail at **call time** — pydoclint-grade strictness on the wire.
---
## 📞 4. Calling Operations
Every `operationId` becomes a method. The call signature is uniform across the whole client:
```python
response = client.<operationId>(
*,
path_params: dict | None = None,
query: dict | None = None,
headers: dict | None = None,
body: Any | None = None,
timeout: float | None = None,
) -> httpx.Response
```
Concrete examples (from the `crud_app` / `health_app` templates):
```python
# No parameters — simplest
response = client.get_health()
assert response.status_code == 200
# Path parameter
response = client.get_item(path_params={"item_id": 3})
# Query parameters
response = client.list_items(query={"limit": 10, "offset": 20})
# JSON request body
response = client.create_item(body={"name": "Orange", "price": 0.8})
# Custom headers / timeout
response = client.get_user(
path_params={"user_id": 1},
headers={"X-Internal-Key": "..."},
timeout=30,
)
```
**Returns:** the raw `httpx.Response`, so `status_code`, `.json()`, `.headers` are all yours to inspect.
---
## 🧠 5. How Parameters Are Bound
For each operation the client knows exactly *where* each parameter belongs:
| OpenAPI location | Client kwarg |
|------------------|-------------------|
| `in: path` | `path_params[name]` |
| `in: query` | `query[name]` |
| `in: header` | `headers[name]` |
| `requestBody` | `body` |
JSON media types are sent as `json=`; other media types as raw `content=`.
---
## 🔄 6. Server ↔ Client, One Spec
```bash
# One directory, two processes
uvicorn main:app --port 8000 # server
python -c "import asyncio; from client_script import run; asyncio.run(run())" # client
```
Or the same client against a remote environment:
```python
client = OpenAPIClient(
spec,
base_url="https://staging.internal.myco",
)
```
The URL is the *only* thing that changes between environments — the contract never does.
---
## ✍️ 7. OperationId as the API
Because the client is operationId-driven:
- Adding an operation = adding a method (and vice versa)
- No operation can be "forgotten" by the client — it's constructed from the spec
- `operationId` is the one name you remember; the HTTP verb/path is an implementation detail
If an `operationId` you call doesn't exist, you get an `AttributeError` at construction-scan time — never a silent 404.
---
## Related
- [01 – Overview](../01_overview.md) · [01 – Quickstart](01_quickstart.md) · [02 – Templates](02_templates.md)

View File

@@ -1,95 +0,0 @@
# Codegen — Generate Models & Routes From Your Spec
> **TL;DR** — point `openapi-first models` / `openapi-first routes` at your spec and get Pydantic models plus operation-matching route stubs. The output is deterministic and is a *starting point* — not a maintained artifact.
---
## 🧭 1. Why Celebrate Codegen?
Two pain points kill OpenAPI projects:
1. **The "write the spec, then write the same thing as Pydantic models" step** — exactly where server/client param types drift (your route says `item_id: int`, your client sends a string…).
2. **Typing handler names by hand** when `bind_routes` requires each `operationId` to resolve to a function of the exact same name.
Codegen collapses both. One command, one source file, the same shapes everywhere.
---
## 🚀 2. Model Generation
```bash
openapi-first models openapi.yaml -o app/_gen/models.py
```
The generated module mirrors the spec's `components.schemas` **by name**:
| Spec | Generated |
|------|-----------|
| `components.schemas.User` | `class User(BaseModel)` |
| `components.schemas.Item` | `class Item(BaseModel)` |
| `required + type` from schema | Pydantic `Field(...)` / type hints ✓ |
**Never hand-edit those files.** If the spec changes, regenerate — just like re-running a compiler after editing source.
### Why constructor-time validation still applies
Codegen doesn't change the design: the generated models are plain Pydantic, and the **client/server still validate against the spec** at startup. Codegen is a *convenience accelerator* on top of the fail-fast guarantees in [04 – Design](../04_design.md) and [06 – Error Handling](../06_error_handling.md).
> **Wire model vs. domain model.** Generated models are the **wire contract**. Keep them separate from your persisted/domain model (see the standards *CRUD Template*): give the wire schema an `id: str`, but model the Mongo document so the id is optional.
---
## 🔁 3. Route Generation
```bash
openapi-first routes openapi.yaml -o app/interfaces \
--use-models --models-module app._gen.models \
--inject-request --package
```
One file per resource (derived from the first path segment). Flags:
| Flag | Effect |
|------|--------|
| `--use-models` | Import request-body `$ref` models from `--models-module` |
| `--models-module MOD` | Dotted module for those imports (default `models`) |
| `--inject-request` | Prepend `request: Request` to every handler (DI convention) |
| `--package` | Emit `<resource>/routes.py` packages (with `__init__.py`) instead of flat `<resource>.py` |
| `--template-style` | Emit `async def` handlers with a JSON body parameter named `body` (the standards-template convention) plus a service-resolution hint, instead of sync `def` handlers taking `payload` |
Why bother? Because `bind_routes` (in [02 – Components](../02_components.md)) needs an `operationId` → handler **exactly** matching the spec. Codegen guarantees you never type a handler name wrong — it wears the same `operationId` the spec declares.
### Resource names and extra media types
- A path such as `/fetch-requests` yields a **sanitized** module name `fetch_requests.py` (a raw hyphen could never be imported).
- `multipart/form-data` and `application/x-www-form-urlencoded` bodies expand to one parameter per schema property: `UploadFile = File(...)` for `format: binary`, `Form(...)` otherwise — not an opaque `payload: dict`. Fields are required only when listed in the schema's `required`.
The stubs `raise NotImplementedError`; fill each body in (typically by resolving a service from `request.app.state`).
### Handler shapes
Both shapes bind equally — the router resolves the handler by `operationId` and introspects the FastAPI signature, so it never inspects the request body:
- **Default (sync stub):** `def create_item(payload: ItemInput, response: Response):` — the body parameter is `payload`.
- **`--template-style`:** `async def create_item(request: Request, body: ItemInput, response: Response):` — matches the standards template (`async def`, `body` parameter, a `request.app.state.db_resources["<resource>_svc"]` hint).
Use `--template-style` when generating against the standards template so the scaffold matches the hand-written handlers you will keep.
> **Note:** `models` / `routes` are build-time tooling. They do **not** run at runtime, and templates (the Bake-your-stuff section of [02 – Templates](02_templates.md)) scaffold a working server out-of-the-box for greenfield projects.
---
## 🧪 4. Idempotent Output
Generated output is deterministic w.r.t. the spec:
- Same spec → byte-identical files (unless you hand-edit — you won't)
- Ordering follows spec declaration order
- No timestamps, no machine names, no hidden randomness
That determinism is what lets you `git diff` after a spec change and see **exactly** what moved.
---
## 🧩 Related
- [01 – Overview](../01_overview.md) · [02 – Templates](02_templates.md) · [03 – Client](03_client.md) · [04 – Design](../04_design.md) · [07 – Testing](../07_testing.md)

View File

@@ -1,87 +0,0 @@
# Design — Guarantees, Startup Pipeline, and the Contract Model
This page is the architecture reference: the fail-fast startup surface, the guarantees that hold by construction, and the trade-offs baked into every decision.
---
## 🏗️ 1. The Startup Pipeline
Everything happens **once, eagerly, at construction time** — for the app at `OpenAPIFirstApp(...)`, for the client at `OpenAPIClient(...)`. There is no lazy loading, no deferred binding, no "it'll work on first request".
```text
openapi.yaml ──► loader.load_openapi
├─ parse (json/yaml by extension)
├─ validate (strict OpenAPI 3.x validator)
└─► dict ──▶ OpenAPISpecLoadError
│
OpenAPIFirstApp(openapi_path=..., routes_module=routes)
├─ 1. load + validate spec (loader)
├─ 2. parse securitySchemes (security)
├─ 3. make_security_dependencies (security)
├─ 4. bind_routes: every operationId ──► routes.<operationId>
│ └─ missing op / missing handler ──► MissingOperationHandler
└─► FastAPI app: routes registry + /openapi.json + Swagger UI
```
Client — same spec, same guarantees:
```text
OpenAPIClient(spec)
├─ require servers[]
├─ require paths
├─ one callable per operationId (client.<operationId>)
│ └─ missing / duplicate opId ──► OpenAPIClientError
└─► ready
```
---
## 📜 2. Guarantees That Hold by Construction
These are not conventions — they are enforced at startup or client construction:
1. **Every route is spec-declared.** Routes are registered *only* from `paths`; there is no decorator-driven or implicit routing.
2. **Every operation is handled.** Each `operationId` resolves to an exact handler name in `routes_module`; a missing one aborts bootstrap.
3. **Every operation has an `operationId`.** An operation without one cannot be bound and fails fast.
4. **Client and server use the same spec.** One document drives both sides, so they cannot drift.
5. **Auth is spec-driven.** `security` dependencies come from `securitySchemes` + per-operation `security`; no manual middleware.
6. **Spec is valid before use.** Invalid, malformed, or unloadable specs are rejected at load, not at first request.
### The startup "no half-states" property
Because binding, validation, and security resolution all run at construction, a booted app is a **provably-complete app**. If the contract is violated in any way, the process refuses to start — the failure is loud, immediate, and tells you exactly what to fix.
---
## 🧩 3. Component Responsibilities
| Module | Owns | Refuses to |
|--------|------|------------|
| `loader` | parse + validate the spec | modify or "fix" the spec |
| `app` | assemble FastAPI from spec + handlers | routing decisions, decorators |
| `binder` | `operationId` → handler mapping | infer handlers from paths |
| `client` | build one callable per `operationId` | guess URLs, deserialize implicitly |
| `security` | schemes → FastAPI `Depends` | manual middleware |
| `errors` | the error hierarchy | swallow failures |
| `codegen` | build-time model/routes generation | runtime codegen |
| `templates` | copyable scaffolds | production data stores |
**Rule of thumb for contributors:** keep modules coercive (they raise if the contract is wrong) and narrow (one responsibility each). Pydoclint + the test suite keep that contract honest.
---
## ⚖️ 4. Design Trade-offs (Accepted)
| Decision | Chosen because | What you give up |
|----------|----------------|------------------|
| Handlers are plain callables | Framework-agnostic, testable, grep-able | No decorator sugar |
| Fail-fast at startup | Drift caught in CI, not at 3am | Slightly heavier boot |
| Raw `httpx.Response` from client | No hidden deserialization/validation | You read `.json()` yourself |
| Build-time codegen | One-way generation, no runtime generator dep | Spec must already be spec-valid |
| Templates copy verbatim | Scaffold, not magic | Templates never updated in place |
---
## 🔗 Related
- [01 – Overview](01_overview.md) · [02 – Components](02_components.md) · [05 – Security](05_security.md) · [06 – Error Handling](06_error_handling.md) · [07 – Testing](07_testing.md)

View File

@@ -1,144 +0,0 @@
# Security — Auth Driven by the Spec, Not by Hand
The most distinctive thing about `openapi-first` security is that you **never write middleware or `Depends(authenticate)` calls yourself**. All authentication is *declared* in the OpenAPI document and *enforced* automatically.
---
## 🗺️ 1. Where Security Lives
Two places in the spec, both respected:
### 1.1 `components.securitySchemes` — the inventory
```yaml
components:
securitySchemes:
internalBearer:
type: http
scheme: bearer
bearerFormat: JWT
x-server-url: "{AUTH_SERVER_URL}"
x-introspect-path: "/introspect"
```
`x-server-url` and `x-introspect-path` are library extensions that point at a JWT introspection endpoint (see [Introspection](#-5-introspection)).
### 1.2 `security` — per-operation (or global) requirements
```yaml
security:
- internalBearer: [] # applied to every operation by default
paths:
/pets:
get:
operationId: list_pets
# inherits: security: [{internalBearer: []}]
post:
operationId: create_pet
security: [] # override — public endpoint
```
OpenAPI dynamic-scoping rules apply: an operation-level `security` **replaces** the global list (it does not merge).
---
## 📖 2. Reading the Spec
`security.py` exposes two functions:
| Function | Returns | Purpose |
|----------|---------|---------|
| `parse_security_schemes(spec)` | `dict[str, dict]` | Collect schemes, resolve `{ENV_VAR}` placeholders |
| `make_security_dependencies(spec, schemes)` | `dict[str, list[Depends]]` (keyed `METHOD:/path`) | Effective per-operation security deps |
Env placeholders of the form `{NAME}` are resolved **once at startup** from `os.environ`. This is how you avoid embedding credentials or auth-service URLs in the committed spec.
---
## 🔐 3. The Bearer Dependency
`make_security_dependencies` builds a FastAPI dependency for `type: http, scheme: bearer`.
Two modes, decided by whether an introspection endpoint is configured:
### 3.1 With introspection (`x-introspect-path`)
- Reads `Authorization: Bearer <token>`
- POSTs `{"token": "<token>"}` to `{x-server-url}{x-introspect-path}` synchronously via the bundled httpx client
- Expects a response with `active: true`
- On valid: `{"user": ...}` from the introspection body → `request.state.user`
- On failure: `401` (missing/invalid token) or `503` (auth service unreachable)
### 3.2 Without introspection
- Validates only that a Bearer token is present
- Stores it on `request.state.token`; no remote call
---
## 🔗 4. Wiring It Together
```python
# server-side
from openapi_first.loader import load_openapi
from openapi_first.security import (
parse_security_schemes,
make_security_dependencies,
)
from openapi_first.app import OpenAPIFirstApp
import routes
spec = load_openapi("openapi.yaml")
schemes = parse_security_schemes(spec)
security_deps = make_security_dependencies(spec, schemes)
app = OpenAPIFirstApp(
openapi_path="openapi.yaml",
routes_module=routes,
)
```
`OpenAPIFirstApp` already does this internally — the snippet above shows what it encapsulates (and what you use directly if you assemble the pieces by hand).
---
## 🧪 5. Testing Security
Because handlers are plain callables, security is the *one* place FastAPI's `TestClient` earns its keep:
```python
from fastapi.testclient import TestClient
def test_unauthenticated_is_401(app, overrides):
with TestClient(app) as client:
r = client.get("/pets")
assert r.status_code == 401
def test_invalid_token_using_fake_introspector(app):
# Point x-introspect-path at a stub uvicorn/TestServer returning active:false
with TestClient(app) as client:
r = client.get("/pets", headers={"Authorization": "Bearer nope"})
assert r.status_code == 401
```
See [Testing](07_testing.md) for the full recipe, including how tests stub the introspection server.
---
## 🛡️ 7. Common Patterns
| Pattern | How |
|---------|-----|
| Public endpoint | `security: []` on the operation |
| Whole-spec auth | top-level `security:` (applies to all) |
| Route-specific scheme | replace `security` on that operation |
| Env-driven auth URL | `x-server-url: "{AUTH_SERVER_URL}"` |
| Offline token carry | scheme without `x-introspect-path` → `request.state.token` |
| Auth on the client side | pass the token via `client.<operationId>(headers={"Authorization": ...})` |
---
## Related
- [02 – Components](02_components.md) · [04 – Design](04_design.md) · [06 – Error Handling](06_error_handling.md) · [07 – Testing](07_testing.md)

View File

@@ -1,121 +0,0 @@
# Error Handling — Fail Loud, Fail Early
`openapi-first` treats errors as **first-class contract documents**: every failure mode is a named exception with a stable import pathhare, and every one surfaces as early as possible.
---
## 🧬 1. The Hierarchy
All errors derive from `OpenAPIFirstError` (in `openapi_first/errors.py`), so a single `except OpenAPIFirstError` catches every first-party failure:
```text
OpenAPIFirstError
├── OpenAPISpecError # spec-level problems
│ └── OpenAPISpecLoadError # load / parse / validation (loader)
├── OpenAPIClientError # client-side contract issues (client)
└── MissingOperationHandler # spec op with no handler (binder)
# Security / loader layers raise through OpenAPISpecError subclasses too
```
| Exception | Module | Raised when |
|----------------------------------|-----------|-------------|
| `OpenAPISpecLoadError` | `loader` | Path missing, file unreadable, YAML/JSON invalid, or spec fails OpenAPI 3.x validation |
| `OpenAPIClientError` | `client` | No `servers`, no `paths`, missing/duplicate `operationId`, missing required params at construction |
| `MissingOperationHandler` | `errors` | An operation is declared whose `operationId` has no matching handler in `routes_module` |
---
## ⏱️ 2. When Things Fail
The single most important rule: **violations are eager, not lazy.**
### 2.1 At application startup
```python
# openapi.yaml missing ────────────────────────────► OpenAPISpecLoadError
# operationId without a handler ───────────────────► MissingOperationHandler
# operation with no operationId declared ──────────► MissingOperationHandler
```
Because these raise during `OpenAPIFirstApp(...)` construction, CI catches them the moment a spec and its routes drift — before a single request is served.
### 2.2 At client construction
```python
OpenAPIClient(spec) # fails fast, same philosophy
```
- Spec with no `servers` → `OpenAPIClientError`
- Spec with no `paths` → `OpenAPIClientError`
- Duplicate `operationId`s → `OpenAPIClientError` (client methods must be unambiguous)
- Operation missing `operationId` → `OpenAPIClientError`
### 2.3 At call time (client)
Runtime transport errors surface as `httpx` exceptions (`httpx.RequestError` family), not swallowed or remapped. Missing required args fail before any HTTP request is made:
```python
client.get_user(path_params={"user_id": ...}) # OK
client.get_user() # ValueError — user_id required
```
---
## 🧰 3. Handling in Your App
### 3.1 Server-side
Handlers raise FastAPI `HTTPException` for expected operation-level failures (404/422), and the `OperationId`-binding errors only exist at startup:
```python
from fastapi import HTTPException
def get_item(item_id: int):
"""Retrieve an item by ID.
Implements the OpenAPI operation ``get_item``.
Args:
item_id (int): Identifier of the item.
Raises:
HTTPException: If the item does not exist (404).
"""
try:
return _get_item(item_id)
except KeyError:
raise HTTPException(status_code=404, detail="Item not found")
```
### 3.2 Client-side
```python
import httpx
try:
response = client.get_item(path_params={"item_id": 1})
except httpx.HTTPStatusError as exc:
... # 4xx/5xx from the server
```
`httpx.HTTPStatusError` isn't raised by the library — it's the standard `httpx.raise_for_status()` you can opt into per call. The library never masks a response code.
---
## 🛡️ 4. Fail-Fast Guarantees Recap
| Layer | You write | The library guarantees |
|-------|-----------|------------------------|
| Loader | a spec path | unreadable/invalid specs never reach your app |
| Binder | handler functions | every operation must resolve, or the app won't start |
| Client | a spec | every operationId becomes a callable; missing ones fail at construction |
| Runtime | handler code | FastAPI + Pydantic handle coercion; contract checks already happened at startup |
None of these can silently degrade: a violation is an **exception at construction**, not a 500 at request time.
---
## Related
- [01 – Overview](01_overview.md) · [05 – Security](05_security.md) · [07 – Testing](07_testing.md)

View File

@@ -1,137 +0,0 @@
# Testing — Smoke-First, Contract-First
Everything `openapi-first` ships is tested against **real specs, real handlers, and real HTTP** through FastAPI's `TestClient` and the bundled templates. There are no fakes of the library itself.
---
## 🧪 1. Suite Overview
```
tests/
├── conftest.py # fixtures: spec_file, routes_module, app, client
├── test_app.py # OpenAPIFirstApp: routes served, overrides, fail-fast
├── test_binder.py # bind_routes: opId resolution + missing-handler failures
├── test_loader.py # load_openapi: json/yaml, env resolution, validation
└── test_client.py # OpenAPIClient: opId→callable, params, error cases
```
Run with:
```bash
pytest # 23 tests, zero mocks of the library
pytest -q
pytest tests/test_loader.py
```
---
## 🏗️ 2. The Fixture Pattern
```python
# conftest.py (abridged)
@pytest.fixture
def spec_file(tmp_path):
path = tmp_path / "openapi.json"
path.write_text(json.dumps(SPEC), encoding="utf-8")
return str(path)
@pytest.fixture
def app(spec_file):
return OpenAPIFirstApp(
openapi_path=spec_file,
routes_module=routes_module(),
)
@pytest.fixture
def client(spec_file):
return OpenAPIClient(json.loads(Path(spec_file).read_text()))
```
---
## 🧪 3. What's Actually Asserted
### 3.1 App-level smoke
```python
def test_app_routes_served(spec_file):
app = OpenAPIFirstApp(openapi_path=spec_file, routes_module=routes)
client = TestClient(app)
assert client.get("/health").json() == {"status": "ok"}
```
### 3.2 Fail-fast (the heart)
```python
def test_app_missing_handler_fails_at_startup(spec_file):
with pytest.raises(MissingOperationHandler):
OpenAPIFirstApp(openapi_path=spec_file, routes_module=empty_routes)
```
### 3.3 Loader validation
```python
def test_loader_invalid_spec_fails():
with pytest.raises(OpenAPISpecLoadError):
load_openapi("broken.yaml")
```
### 3.4 Client contract drift
```python
def test_client_duplicate_operation_id_raises():
with pytest.raises(OpenAPIClientError):
OpenAPIClient(dup_spec)
```
---
## 🏛️ 4. Testing the Templates
Each bundled template ships its own test + in-memory store, so you get a runnable contract test the moment you scaffold:
```bash
openapi-first scaffold crud_app my-service
cd my-service
pytest -q
```
`test_crud_app.py` / `test_model_app.py` / `test_vet_app.py` exercise the full CRUD surface through `TestClient` — including `201`/`204` status codes, 404s, and (in `vet_app`) SSE streaming via `StreamingResponse`.
---
## 🕹️ 5. Quality Gates (CI)
The same gates the library itself must pass are what keep the docs honest:
| Gate | Purpose |
|------|---------|
| `black --check` | formatting parity |
| `ruff check` | lint hygiene |
| `mypy` | type safety (strict, `--disable-error-code` where intentional) |
| `pytest` | 23 tests, green |
| coverage | tracked via pytest-cov (HTML + XML + term) |
Run the whole gate locally:
```bash
black --check openapi_first tests
ruff check openapi_first tests
mypy openapi_first
pytest
```
---
## 💡 6. Testing Tips
- **Start from startup:** assert `OpenAPIFirstApp(...)` *raises* for the broken contracts — those are your most valuable tests
- **Client ↔ server:** smoke a client against the same spec the app was built from — one spec, two sides, zero drift
- **Templates are scaffolds:** their tests are copyable starting points, not canonical suites
- **No mocking of the library:** exercise loader → binder → app → client as a real pipeline
---
## Related
- [01 – Overview](01_overview.md) · [02 – Components](02_components.md) · [04 – Error Handling](06_error_handling.md)

View File

@@ -1,62 +0,0 @@
# 🧩 openapi-first — OpenAPI as the Single Source of Truth
`openapi-first` is a small, strict library for **OpenAPI-first FastAPI bootstrapping**: the OpenAPI document *is* the application contract — not an afterthought generated from decorators)Skip. Routes, schemas, security, and even the HTTP client are all derived from one specification.
> **Doc model:** this wiki is written for humans — how-to guides, examples, and usage recipes. The authoritative API contracts live in the code (docstrings) and the machine-readable bundle under `docs/mcp/`.
---
## 🚀 Key Features
* 📜 **One spec, two sides** — the same OpenAPI document boots both a FastAPI server (`OpenAPIFirstApp`) and a strict HTTP client (`OpenAPIClient`)
* 🔗 **`operationId` binding** — handler functions are bound to routes purely by `operationId`; no routing decorators
* 🧱 **Fail-fast contracts** — startup and client construction fail loudly when a handler, operation, or security scheme is missing
* 🛡️ **Spec-driven security** — `securitySchemes` + per-operation `security` auto-injected as FastAPI dependencies (Bearer JWT introspection included)
* 🧠 **Contract-first codegen** — `models` (Pydantic) and `routes` (resource stubs) generated from a spec
* 🧩 **Bundled templates** — `health_app`, `crud_app`, `model_app`, `vet_app` scaffolds for the whole lifecycle, from `/health` to SSE + multi-resource CRUD
---
## 📦 Installation
From your internal PyPI:
```bash
pip install --extra-index-url https://$PYPI_USERNAME:$PYPI_PASSWORD@pip.aetoskia.com/simple openapi-first
```
From local source:
```bash
pip install -e .
```
---
## 📁 Documentation Structure
| Section | Description |
|---------|-------------|
| [Overview](01_overview.md) | The mental model: spec as contract, `operationId` binding, fail-fast guarantees |
| [Components](02_components.md) | `app`, `binder`, `loader`, `client`, `errors`, `security`, `codegen`, `cli` |
| **Use cases** | Step-by-step recipes |
| · [01 – Quickstart](03_use_cases/01_quickstart.md) | Scaffold your first OpenAPI-first service |
| · [02 – Templates](03_use_cases/02_templates.md) | The bundled application templates and how to use them |
| · [03 – Client setup](03_use_cases/03_client.md) | Build an `operationId`-driven HTTP client |
| · [04 – Codegen](03_use_cases/04_codegen.md) | Generate Pydantic models and route stubs from a spec |
| [Design](04_design.md) | Architecture, responsibilities, and startup pipeline |
| [Security](05_security.md) | `securitySchemes`, env resolution, and JWT introspection |
| [Error Handling](06_error_handling.md) | The error hierarchy and when each error is raised |
| [Testing](07_testing.md) | Test strategy, quality gates, and coverage |
---
## 🔗 Related Resources
* **Source Code:** [Gitea Repository](https://git.aetoskia.com/aetos/openapi-first)
* **Internal PyPI:** [pip.aetoskia.com/simple/openapi-first](https://pip.aetoskia.com/simple/openapi-first)
* **Drone CI:** Auto-builds and publishes tagged releases, gated on black / ruff / mypy / pytest.
---
© Aetoskia Internal — `openapi-first` 0.0.6

Some files were not shown because too many files have changed in this diff Show More