Files
docs/libs/openapi-first/site/openapi_first/app/index.html
Vishesh 'ironeagle' Bangotra 24ecde4222
All checks were successful
continuous-integration/drone/push Build is passing
added more libs
2026-01-22 17:20:17 +05:30

1125 lines
26 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../">
<link rel="next" href="../binder/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>App - openapi_first</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#app" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
openapi_first
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
App
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Application Bootstrap
</a>
</li>
<li class="md-tabs__item">
<a href="../loader/" class="md-tabs__link">
Core Utilities
</a>
</li>
<li class="md-tabs__item">
<a href="../client/" class="md-tabs__link">
OpenAPI Client
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
openapi_first
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Application Bootstrap
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Application Bootstrap
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
App
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
App
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#openapi_first.app" class="md-nav__link">
<span class="md-ellipsis">
app
</span>
</a>
<nav class="md-nav" aria-label="app">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app--openapi_firstapp" class="md-nav__link">
<span class="md-ellipsis">
openapi_first.app
</span>
</a>
<nav class="md-nav" aria-label="openapi_first.app">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app--core-principles" class="md-nav__link">
<span class="md-ellipsis">
Core principles
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--what-this-module-does" class="md-nav__link">
<span class="md-ellipsis">
What this module does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--what-this-module-does-not-do" class="md-nav__link">
<span class="md-ellipsis">
What this module does NOT do
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--intended-usage" class="md-nav__link">
<span class="md-ellipsis">
Intended usage
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp" class="md-nav__link">
<span class="md-ellipsis">
OpenAPIFirstApp
</span>
</a>
<nav class="md-nav" aria-label="OpenAPIFirstApp">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--behavior-guarantees" class="md-nav__link">
<span class="md-ellipsis">
Behavior guarantees
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../binder/" class="md-nav__link">
<span class="md-ellipsis">
Binder
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Core Utilities
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Core Utilities
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../loader/" class="md-nav__link">
<span class="md-ellipsis">
Loader
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../errors/" class="md-nav__link">
<span class="md-ellipsis">
Errors
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
OpenAPI Client
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
OpenAPI Client
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../client/" class="md-nav__link">
<span class="md-ellipsis">
Client
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#openapi_first.app" class="md-nav__link">
<span class="md-ellipsis">
app
</span>
</a>
<nav class="md-nav" aria-label="app">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app--openapi_firstapp" class="md-nav__link">
<span class="md-ellipsis">
openapi_first.app
</span>
</a>
<nav class="md-nav" aria-label="openapi_first.app">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app--core-principles" class="md-nav__link">
<span class="md-ellipsis">
Core principles
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--what-this-module-does" class="md-nav__link">
<span class="md-ellipsis">
What this module does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--what-this-module-does-not-do" class="md-nav__link">
<span class="md-ellipsis">
What this module does NOT do
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app--intended-usage" class="md-nav__link">
<span class="md-ellipsis">
Intended usage
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp" class="md-nav__link">
<span class="md-ellipsis">
OpenAPIFirstApp
</span>
</a>
<nav class="md-nav" aria-label="OpenAPIFirstApp">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--behavior-guarantees" class="md-nav__link">
<span class="md-ellipsis">
Behavior guarantees
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.app.OpenAPIFirstApp--example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="app">App</h1>
<div class="doc doc-object doc-module">
<h2 id="openapi_first.app" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">openapi_first.app</span>
</h2>
<div class="doc doc-contents first">
<h3 id="openapi_first.app--openapi_firstapp">openapi_first.app</h3>
<p>OpenAPI-first application bootstrap for FastAPI.</p>
<p>This module provides <code>OpenAPIFirstApp</code>, a thin but strict abstraction
that enforces OpenAPI as the single source of truth for a FastAPI service.</p>
<h4 id="openapi_first.app--core-principles">Core principles</h4>
<ul>
<li>The OpenAPI specification (JSON or YAML) defines the entire API surface.</li>
<li>Every operationId in the OpenAPI spec must have a corresponding
Python handler function.</li>
<li>Handlers are plain Python callables (no FastAPI decorators).</li>
<li>FastAPI route registration is derived exclusively from the spec.</li>
<li>FastAPI's autogenerated OpenAPI schema is fully overridden.</li>
</ul>
<h4 id="openapi_first.app--what-this-module-does">What this module does</h4>
<ul>
<li>Loads and validates an OpenAPI 3.x specification.</li>
<li>Dynamically binds HTTP routes to handler functions using operationId.</li>
<li>Registers routes with FastAPI at application startup.</li>
<li>Ensures runtime behavior matches the OpenAPI contract exactly.</li>
</ul>
<h4 id="openapi_first.app--what-this-module-does-not-do">What this module does NOT do</h4>
<ul>
<li>It does not generate OpenAPI specs.</li>
<li>It does not generate client code.</li>
<li>It does not introduce a new framework or lifecycle.</li>
<li>It does not alter FastAPI dependency injection semantics.</li>
</ul>
<h4 id="openapi_first.app--intended-usage">Intended usage</h4>
<p>This module is intended for teams that want:</p>
<ul>
<li>OpenAPI-first API development</li>
<li>Strong contract enforcement</li>
<li>Minimal FastAPI boilerplate</li>
<li>Predictable, CI-friendly failures for spec/implementation drift</li>
</ul>
<div class="doc doc-children">
<div class="doc doc-object doc-class">
<h3 id="openapi_first.app.OpenAPIFirstApp" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">OpenAPIFirstApp</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">OpenAPIFirstApp</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">openapi_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">routes_module</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">fastapi_kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span>
</code></pre></div>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="fastapi.FastAPI">FastAPI</span></code></p>
<p>FastAPI application enforcing OpenAPI-first design.</p>
<p><code>OpenAPIFirstApp</code> subclasses FastAPI and replaces manual route
registration with OpenAPI-driven binding. All routes are derived
from the provided OpenAPI specification, and each operationId is
mapped to a Python function in the supplied routes module.</p>
<h5 id="openapi_first.app.OpenAPIFirstApp--parameters">Parameters</h5>
<p>openapi_path : str
Filesystem path to the OpenAPI 3.x specification file.
This specification is treated as the authoritative API contract.</p>
<details class="routes_module-" open>
<summary>module</summary>
<p>Python module containing handler functions whose names correspond
exactly to OpenAPI operationId values.</p>
</details> <p>**fastapi_kwargs
Additional keyword arguments passed directly to <code>fastapi.FastAPI</code>
(e.g., title, version, middleware, lifespan handlers).</p>
<h5 id="openapi_first.app.OpenAPIFirstApp--raises">Raises</h5>
<p>OpenAPIFirstError
If the OpenAPI specification is invalid, or if any declared
operationId does not have a corresponding handler function.</p>
<h5 id="openapi_first.app.OpenAPIFirstApp--behavior-guarantees">Behavior guarantees</h5>
<ul>
<li>No route can exist without an OpenAPI declaration.</li>
<li>No OpenAPI operation can exist without a handler.</li>
<li>Swagger UI and <code>/openapi.json</code> always reflect the provided spec.</li>
<li>Handler functions remain framework-agnostic and testable.</li>
</ul>
<h5 id="openapi_first.app.OpenAPIFirstApp--example">Example</h5>
<blockquote>
<blockquote>
<blockquote>
<p>from openapi_first import OpenAPIFirstApp
import app.routes as routes</p>
<p>app = OpenAPIFirstApp(
... openapi_path="app/openapi.json",
... routes_module=routes,
... title="Example Service"
... )</p>
</blockquote>
</blockquote>
</blockquote>
<div class="doc doc-children">
</div>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>