using doc-forge

mcp_docs/modules/openapi_first.templates.model_app.main.json

@@ -0,0 +1,39 @@
+{
+  "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": "<bound method Alias.signature of Alias('OpenAPIFirstApp', 'openapi_first.app.OpenAPIFirstApp')>",
+        "docstring": "FastAPI application enforcing OpenAPI-first design.\n\n`OpenAPIFirstApp` subclasses FastAPI and replaces manual route\nregistration with OpenAPI-driven binding. All routes are derived\nfrom the provided OpenAPI specification, and each operationId is\nmapped to a Python function in the supplied routes module.\n\nParameters\n----------\nopenapi_path : str\n    Filesystem path to the OpenAPI 3.x specification file.\n    This specification is treated as the authoritative API contract.\n\nroutes_module : module\n    Python module containing handler functions whose names correspond\n    exactly to OpenAPI operationId values.\n\n**fastapi_kwargs\n    Additional keyword arguments passed directly to `fastapi.FastAPI`\n    (e.g., title, version, middleware, lifespan handlers).\n\nRaises\n------\nOpenAPIFirstError\n    If the OpenAPI specification is invalid, or if any declared\n    operationId does not have a corresponding handler function.\n\nBehavior 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\nExample\n-------\n>>> from openapi_first 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... )",
+        "members": {
+          "openapi": {
+            "name": "openapi",
+            "kind": "attribute",
+            "path": "openapi_first.templates.model_app.main.OpenAPIFirstApp.openapi",
+            "signature": "<bound method Alias.signature of Alias('openapi', 'openapi_first.app.OpenAPIFirstApp.openapi')>",
+            "docstring": null
+          }
+        }
+      },
+      "routes": {
+        "name": "routes",
+        "kind": "alias",
+        "path": "openapi_first.templates.model_app.main.routes",
+        "signature": "<bound method Alias.signature of Alias('routes', 'routes')>",
+        "docstring": null
+      },
+      "app": {
+        "name": "app",
+        "kind": "attribute",
+        "path": "openapi_first.templates.model_app.main.app",
+        "signature": null,
+        "docstring": null
+      }
+    }
+  }
+}