1127 lines
34 KiB
HTML
1127 lines
34 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="../01_quickstart/">
|
||
|
||
|
||
<link rel="next" href="../03_client/">
|
||
|
||
|
||
<link rel="icon" href="../../assets/images/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
|
||
|
||
|
||
|
||
<title>Templates - 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=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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="blue-grey" data-md-color-accent="teal">
|
||
|
||
|
||
<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="#use-case-2-templates-copyable-reference-applications" 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="M7 7H5a2 2 0 0 0-2 2v8h2v-4h2v4h2V9a2 2 0 0 0-2-2m0 4H5V9h2m7-2h-4v10h2v-4h2a2 2 0 0 0 2-2V9a2 2 0 0 0-2-2m0 4h-2V9h2m6 0v6h1v2h-4v-2h1V9h-1V7h4v2Z"/></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">
|
||
|
||
Templates
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<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">
|
||
|
||
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
||
</a>
|
||
|
||
<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>
|
||
|
||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||
|
||
</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">
|
||
<a href="../../01_overview/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Overview
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../02_components/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Components
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item md-tabs__item--active">
|
||
<a href="../01_quickstart/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Use Cases
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../04_design/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Design
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../05_security/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Security
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../06_error_handling/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Error Handling
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../07_testing/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Testing
|
||
|
||
</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 md-nav--integrated" 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="M7 7H5a2 2 0 0 0-2 2v8h2v-4h2v4h2V9a2 2 0 0 0-2-2m0 4H5V9h2m7-2h-4v10h2v-4h2a2 2 0 0 0 2-2V9a2 2 0 0 0-2-2m0 4h-2V9h2m6 0v6h1v2h-4v-2h1V9h-1V7h4v2Z"/></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">
|
||
<a href="../../01_overview/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Overview
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../02_components/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Components
|
||
|
||
</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_4" checked>
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Use Cases
|
||
|
||
</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="true">
|
||
<label class="md-nav__title" for="__nav_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Use Cases
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../01_quickstart/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Quickstart
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<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">
|
||
Templates
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Templates
|
||
|
||
</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="#1-what-templates-are" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🎬 1. What Templates Are
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#2-the-four-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
📋 2. The Four Templates
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="📋 2. The Four Templates">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#21-health_app-minimal-liveness-probe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
2.1 health_app — minimal liveness probe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#22-crud_app-dict-based-crud" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
2.2 crud_app — dict-based CRUD
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#23-model_app-pydantic-model-crud" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
2.3 model_app — Pydantic model CRUD
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#24-vet_app-the-full-featured-demo" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
2.4 vet_app — the full-featured demo
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#3-cli-reference" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🚀 3. CLI Reference
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#4-anatomy-of-a-scaffolded-service" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🧩 4. Anatomy of a Scaffolded Service
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#5-production-disclaimer" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
⚠️ 5. Production Disclaimer
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#related" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Related
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../03_client/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Client
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../04_codegen/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Codegen
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../04_design/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Design
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../05_security/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Security
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../06_error_handling/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Error Handling
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../07_testing/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Testing
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
<h1 id="use-case-2-templates-copyable-reference-applications">Use Case 2: Templates — Copyable Reference Applications</h1>
|
||
<p><code>openapi-first</code> ships four runnable, copyable applications under <code>openapi_first/templates/</code>. They are <strong>not part of the library API</strong> — they are bundled scaffold examples you copy into your own project and build on.</p>
|
||
<hr />
|
||
<h2 id="1-what-templates-are">🎬 1. What Templates Are</h2>
|
||
<p>A template is a complete, self-contained OpenAPI-first service:</p>
|
||
<ul>
|
||
<li>A bundled directory inside <code>openapi_first/templates/<name>/</code></li>
|
||
<li>Copyable <strong>verbatim</strong> — no code generation, no mutation — via the CLI</li>
|
||
<li>Each one demonstrates a specific set of OpenAPI-first behaviors and FastAPI features</li>
|
||
</ul>
|
||
<p>All templates share the same skeleton:</p>
|
||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
|
||
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
|
||
<span class="normal"><a href="#__codelineno-0-5">5</a></span>
|
||
<span class="normal"><a href="#__codelineno-0-6">6</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><name>_app/
|
||
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>├── __init__.py # explains the template + how to scaffold it
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>├── openapi.yaml # the contract (source of truth)
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a>├── main.py # assembles OpenAPIFirstApp from the spec
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a>├── routes.py # operationId-bound handler functions
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a>└── data.py # in-memory data store (demo only)
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<hr />
|
||
<h2 id="2-the-four-templates">📋 2. The Four Templates</h2>
|
||
<h3 id="21-health_app-minimal-liveness-probe">2.1 <code>health_app</code> — minimal liveness probe</h3>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-1-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-1-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>health_app
|
||
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a><span class="c1"># or into a custom directory:</span>
|
||
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>health_app<span class="w"> </span>my-health-service
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>File</th>
|
||
<th>Purpose</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>openapi.yaml</code></td>
|
||
<td><code>GET /health</code> → <code>operationId: get_health</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>routes.py</code></td>
|
||
<td><code>get_health()</code> returns <code>{"status": "ok"}</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>main.py</code></td>
|
||
<td><code>OpenAPIFirstApp(openapi_path="openapi.yaml", routes_module=routes)</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Why it exists:</strong> the absolute minimal OpenAPI-first round trip — one operation, one handler, zero moving parts. The best starting point to internalize the mental model.</p>
|
||
<p><strong>Smoke test:</strong></p>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-2-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-2-3">3</a></span>
|
||
<span class="normal"><a href="#__codelineno-2-4">4</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
|
||
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a>uvicorn<span class="w"> </span>main:app
|
||
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3"></a>curl<span class="w"> </span>http://localhost:8000/health
|
||
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4"></a><span class="c1"># → {"status": "ok"}</span>
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<h3 id="22-crud_app-dict-based-crud">2.2 <code>crud_app</code> — dict-based CRUD</h3>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-3-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>crud_app<span class="w"> </span>my-crud-service
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>File</th>
|
||
<th>Purpose</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>openapi.yaml</code></td>
|
||
<td>Full CRUD over <code>/items</code> (list/get/create/update/delete)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>routes.py</code></td>
|
||
<td>Handlers bound via <code>operationId</code>s <code>list_items</code>, <code>get_item</code>, <code>create_item</code>, <code>update_item</code>, <code>delete_item</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>data.py</code></td>
|
||
<td>In-memory dict store with auto-incrementing <code>id</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Behaviors you learn:</p>
|
||
<ul>
|
||
<li><strong>Explicit status codes</strong> — <code>create_item</code>/<code>delete_item</code> take <code>response: Response</code> and set <code>201</code>/<code>204</code>; <code>get_item</code>/<code>update_item</code> raise <code>HTTPException(404)</code> on <code>KeyError</code></li>
|
||
<li><strong>Handlers as plain callables</strong> — no FastAPI decorators, routing comes solely from the spec</li>
|
||
<li><strong>Mock data store</strong> — <code>data.py</code> is a copyable in-memory store, explicitly <strong>not</strong> production-ready</li>
|
||
</ul>
|
||
<h3 id="23-model_app-pydantic-model-crud">2.3 <code>model_app</code> — Pydantic model CRUD</h3>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>model_app<span class="w"> </span>my-model-service
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>File</th>
|
||
<th>Purpose</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>openapi.yaml</code></td>
|
||
<td>Same CRUD surface, schemas reference models</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>models.py</code></td>
|
||
<td>Pydantic <code>Item</code>, <code>ItemCreate</code>, <code>ItemBase</code> (request/response models)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>routes.py</code></td>
|
||
<td>Handlers type-annotated with the models; <code>create_item</code> sets <code>201</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>data.py</code></td>
|
||
<td>In-memory store returning real model instances</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Behaviors you learn:</p>
|
||
<ul>
|
||
<li><strong>Pydantic request/response models</strong> — payloads validated and serialized via FastAPI</li>
|
||
<li><strong>Same handler contracts</strong> — identical <code>operationId</code> set as <code>crud_app</code>, so the two are interchangeable</li>
|
||
<li><strong>Models in the client too</strong> — the same spec drives <code>OpenAPIClient</code> body handling</li>
|
||
</ul>
|
||
<h3 id="24-vet_app-the-full-featured-demo">2.4 <code>vet_app</code> — the full-featured demo</h3>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-5-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>vet_app<span class="w"> </span>my-vet-clinic
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>File</th>
|
||
<th>Purpose</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>openapi.yaml</code></td>
|
||
<td>Five resources (parents, vets, treatments, pets, appointments) + SSE + upload + discriminated unions</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>models.py</code></td>
|
||
<td>Pydantic models incl. <strong>discriminated unions</strong> (<code>noteType</code> literal fields)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>routes.py</code></td>
|
||
<td>~20 handlers across all resources, incl. pagination, filtering, photo upload, SSE streaming</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sse.py</code></td>
|
||
<td>Server-Sent Events helper (<code>StreamingResponse</code>, per-pet subscriber queues, background <code>asyncio</code> workers)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>data.py</code></td>
|
||
<td>Larger in-memory store (parents → vets → treatments → pets → appointments)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>main.py</code></td>
|
||
<td>App + CORS + lifespan example</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Behaviors you learn — the <em>advanced</em> tier:</p>
|
||
<ul>
|
||
<li><strong>Discriminated unions</strong> — <code>ProcedureNotes</code> uses <code>oneOf</code> + <code>discriminator.noteType</code> mapping; Pydantic models use <code>Literal[...]</code> discriminator fields</li>
|
||
<li><strong>SSE streaming</strong> — a <code>GET /pets/{id}/actions</code> operation streaming <code>text/event-stream</code> via <code>StreamingResponse</code> with background task workers</li>
|
||
<li><strong>File upload</strong> — <code>UploadFile</code> handler setting a multi-part body</li>
|
||
<li><strong>CORS + middleware</strong> — <code>add_middleware(CORSMiddleware, ...)</code> alongside the spec-driven setup</li>
|
||
<li><strong>Response injection</strong> — handlers set <code>201</code>/<code>204</code> explicitly via injected <code>Response</code></li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="3-cli-reference">🚀 3. CLI Reference</h2>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-6-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-3">3</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-4">4</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-5">5</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-6">6</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-7">7</a></span>
|
||
<span class="normal"><a href="#__codelineno-6-8">8</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a><span class="c1"># List available templates</span>
|
||
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>--list
|
||
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3"></a>
|
||
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4"></a><span class="c1"># Copy a template into its default directory (template name, dashes)</span>
|
||
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>health_app
|
||
</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6"></a>
|
||
</span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7"></a><span class="c1"># Copy into a custom target directory</span>
|
||
</span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8"></a>openapi-first<span class="w"> </span>scaffold<span class="w"> </span>crud_app<span class="w"> </span>my-project/crud
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<blockquote>
|
||
<p><strong>Protip:</strong> <code>DEFAULT_TEMPLATE</code> is <code>health_app</code>, so <code>openapi-first scaffold</code> with no template name scaffolds the health app.</p>
|
||
</blockquote>
|
||
<hr />
|
||
<h2 id="4-anatomy-of-a-scaffolded-service">🧩 4. Anatomy of a Scaffolded Service</h2>
|
||
<p>After <code>openapi-first scaffold health_app my-health-service</code>, your directory contains a drop-in FastAPI service:</p>
|
||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-7-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-7-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-7-3">3</a></span>
|
||
<span class="normal"><a href="#__codelineno-7-4">4</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1"></a>my-health-service/
|
||
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2"></a>├── openapi.yaml # THE contract
|
||
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3"></a>├── main.py # `app = OpenAPIFirstApp(openapi_path=..., routes_module=routes)`
|
||
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4"></a>└── routes.py # `def get_health(): ...`
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<p>Run it:</p>
|
||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-8-1">1</a></span>
|
||
<span class="normal"><a href="#__codelineno-8-2">2</a></span>
|
||
<span class="normal"><a href="#__codelineno-8-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1"></a><span class="nb">cd</span><span class="w"> </span>my-health-service
|
||
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2"></a>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
|
||
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3"></a>uvicorn<span class="w"> </span>main:app<span class="w"> </span>--reload
|
||
</span></code></pre></div></td></tr></table></div>
|
||
<p><code>/docs</code>, <code>/openapi.json</code>, and every declared route now exist — all derived from <code>openapi.yaml</code>.</p>
|
||
<hr />
|
||
<h2 id="5-production-disclaimer">⚠️ 5. Production Disclaimer</h2>
|
||
<p>Templates use <strong>in-memory, non-persistent, non-concurrency-safe</strong> data stores. They are learning scaffolds — <strong>not</strong> production references. Swap in a real data layer (SQL/REDIS/object store) the moment you go beyond a demo.</p>
|
||
<p>See the <code>__init__.py</code> of each template for detailed client examples, CLI examples, and design notes.</p>
|
||
<hr />
|
||
<h2 id="related">Related</h2>
|
||
<ul>
|
||
<li><a href="../01_quickstart/">01 – Quickstart</a> · <a href="../04_codegen/">04 – Codegen</a> · <a href="../../02_components/">02 – Components</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
||
|
||
<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.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"], "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> |