<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>FastAPI &#8211; CFXLOG</title>
	<atom:link href="https://cfxlog.com/category/python/fastapi/feed/index.xml" rel="self" type="application/rss+xml" />
	<link>https://cfxlog.com/</link>
	<description></description>
	<lastBuildDate>Wed, 11 Nov 2026 22:25:33 +0000</lastBuildDate>
	<language>ja</language>
	<sy:updatePeriod>
	hourly	</sy:updatePeriod>
	<sy:updateFrequency>
	1	</sy:updateFrequency>
	<generator>https://wordpress.org/?v=7.1.4</generator>

<image>
	<url>https://cfxlog.com/wp-content/uploads/2026/07/cfxlog-favicon-150x150.png</url>
	<title>FastAPI &#8211; CFXLOG</title>
	<link>https://cfxlog.com/</link>
	<width>32</width>
	<height>32</height>
</image> 
	<item>
		<title>FastAPI入門ガイド｜ルーティングの基本と依存関係の付き合い方</title>
		<link>https://cfxlog.com/python-fastapi-guide/</link>
		
		<dc:creator><![CDATA[CFXLOG]]></dc:creator>
		<pubDate>Fri, 31 Jul 2026 15:00:00 +0000</pubDate>
				<category><![CDATA[FastAPI]]></category>
		<guid isPermaLink="false">https://cfxlog.com/python-fastapi-guide/</guid>

					<description><![CDATA[このような疑問にお答えします。 FastAPIは、Pythonで書けるAPI特化のWebフレームワークです。型ヒントをベースにしたバリデーションと、自動生成されるAPIドキュメントが特徴です。 このガイドでは、FastA [&#8230;]]]></description>
										<content:encoded><![CDATA[
<div class="wp-block-group is-style-crease"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>FastAPIって何がうれしいの？</li>

<li>Djangoとどう違うのか、どっちを使えばいいのかわからない</li>

<li>ライブラリの組み合わせが多くて、環境構築でつまずきそう</li>
</ul>
</div></div>



<p class="wp-block-paragraph">このような疑問にお答えします。</p>



<p class="wp-block-paragraph">FastAPIは、Pythonで書けるAPI特化のWebフレームワークです。型ヒントをベースにしたバリデーションと、自動生成されるAPIドキュメントが特徴です。</p>



<p class="wp-block-paragraph">このガイドでは、<strong>FastAPIの基本的な考え方から、実際にAPIを1つ動かすところまで</strong>を解説します。後半には関連記事へのロードマップも用意しています。</p>



<div id="rtoc-mokuji-wrapper" class="rtoc-mokuji-content frame2 preset5 animation-fade rtoc_open default" data-id="5402" data-theme="SWELL CHILD">
			<div id="rtoc-mokuji-title" class=" rtoc_left">
			<button class="rtoc_open_close rtoc_open"></button>
			<span>目次</span>
			</div><ol class="rtoc-mokuji mokuji_ol level-1"><li class="rtoc-item"><a href="#rtoc-1">FastAPIとは何か</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-2">正直、僕はFastAPIを自分から選ぶことはあまりない</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-3">FastAPIを始める前に知っておきたいこと</a></li><li class="rtoc-item"><a href="#rtoc-4">はじめてのAPIを書いてみよう</a></li><li class="rtoc-item"><a href="#rtoc-5">関連記事</a></li><li class="rtoc-item"><a href="#rtoc-6">まとめ</a></li></ol></div><h2 id="rtoc-1"  class="wp-block-heading">FastAPIとは何か</h2>



<p class="wp-block-paragraph">FastAPIは、Pythonの型ヒントを使ってAPIのリクエスト・レスポンスを定義するWebフレームワークです。型ヒントを書くだけで、リクエストデータのバリデーションと、Swagger UIによる対話的なAPIドキュメントが自動生成されます。</p>



<p class="wp-block-paragraph">DjangoがWebアプリ全般を想定した「フルスタック」寄りのフレームワークなのに対し、FastAPIはAPIサーバーに機能を絞っています。管理画面やテンプレートエンジンは標準では付いてきません。</p>



<h3 id="rtoc-2"  class="wp-block-heading">正直、僕はFastAPIを自分から選ぶことはあまりない</h3>



<p class="wp-block-paragraph">正直に言うと、僕は普段からFastAPIを積極的に選ぶタイプではありません。案件やプロジェクトで既にFastAPIが採用されていて、それに対応する形で触ることがほとんどです。</p>



<p class="wp-block-paragraph">とはいえ、慣れてしまえば身構えるほどのフレームワークでもありません。このガイドは「自分から選んで学ぶ人」よりも、「必要になったから触ることになった人」を想定して書いています。</p>



<h2 id="rtoc-3"  class="wp-block-heading">FastAPIを始める前に知っておきたいこと</h2>



<p class="wp-block-paragraph">FastAPI自体はシンプルですが、実際に動かすにはUvicorn（ASGIサーバー）やPydantic（データ検証）など、いくつかのライブラリを組み合わせる必要があります。</p>



<p class="wp-block-paragraph">ここが最初につまずきやすいポイントです。僕自身、Djangoのように機能がひとつにまとまっている感覚でいたので、複数のライブラリの依存関係やバージョンの組み合わせを自分で把握する必要がある点の取り回しに、最初は戸惑いました。</p>



<p class="wp-block-paragraph">ただ、これは裏を返せば「必要なものだけ組み合わせられる」ということでもあります。最初の環境構築さえ乗り切れば、あとの学習コストはそこまで高くありません。</p>



<h2 id="rtoc-4"  class="wp-block-heading">はじめてのAPIを書いてみよう</h2>



<p class="wp-block-paragraph">理屈より先に、実際に動くAPIを見てみましょう。GETリクエストを受けてJSONを返す、最小構成の例です。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

app = FastAPI()

@app.get("/hello")
def hello():
    return {"message": "Hello, FastAPI!"}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color:#1E1E1E;color:#D4D4D4" tabindex="0"><code><span class="line"><span style="color:#C586C0">from</span><span style="color:#D4D4D4"> fastapi </span><span style="color:#C586C0">import</span><span style="color:#D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color:#D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color:#DCDCAA">@app.get</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">"/hello"</span><span style="color:#D4D4D4">)</span></span>
<span class="line"><span style="color:#569CD6">def</span><span style="color:#DCDCAA"> hello</span><span style="color:#D4D4D4">():</span></span>
<span class="line"><span style="color:#C586C0">    return</span><span style="color:#D4D4D4"> {</span><span style="color:#CE9178">"message"</span><span style="color:#D4D4D4">: </span><span style="color:#CE9178">"Hello, FastAPI!"</span><span style="color:#D4D4D4">}</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>@app.get("/hello")</code>のようにデコレータでパスとHTTPメソッドを指定するだけで、ルーティングが完成します。関数の戻り値をそのままJSONとして返してくれるので、レスポンスの組み立てで悩むこともありません。</p>



<h2 id="rtoc-5"  class="wp-block-heading">関連記事</h2>



<p class="wp-block-paragraph">基本が掴めたら、以下の記事でさらに実践的な使い方を解説しています。モデル設計・DB連携・認証・デプロイ編は現在準備中です。</p>


<div class="swell-block-postLink">			<div class="p-blogCard -internal" data-type="type1" data-onclick="clickLink">
				<div class="p-blogCard__inner">
					<span class="p-blogCard__caption">あわせて読みたい</span>
					<div class="p-blogCard__thumb c-postThumb"><figure class="c-postThumb__figure"><img decoding="async" src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-quickstart-300x158.jpg" alt="" class="c-postThumb__img u-obf-cover" width="320" height="180"></figure></div>					<div class="p-blogCard__body">
						<a class="p-blogCard__title" href="https://cfxlog.com/python-fastapi-quickstart/">【入門編】FastAPIスピードマスターガイド</a>
						<span class="p-blogCard__excerpt">FastAPIの概要を知りたい 公式チュートリアルを読むのが面倒 簡単な使い方をマスターしたい FastAPI はフルスタックフレームワークの Django に比べると直感的かつシン&#8230;</span>					</div>
				</div>
			</div>
		</div>

<div class="swell-block-postLink">			<div class="p-blogCard -internal" data-type="type1" data-onclick="clickLink">
				<div class="p-blogCard__inner">
					<span class="p-blogCard__caption">あわせて読みたい</span>
					<div class="p-blogCard__thumb c-postThumb"><figure class="c-postThumb__figure"><img decoding="async" src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-routing-300x158.jpg" alt="" class="c-postThumb__img u-obf-cover" width="320" height="180"></figure></div>					<div class="p-blogCard__body">
						<a class="p-blogCard__title" href="https://cfxlog.com/python-fastapi-routing/">【FastAPI】API ルーティングの設計について徹底解説！</a>
						<span class="p-blogCard__excerpt">FastAPI のルーティングの方法が知りたい バリデーションってどうやるの？ このような疑問にお答えします。 FastAPI では関数を使ってルーティングを表現するので、端的&#8230;</span>					</div>
				</div>
			</div>
		</div>


<h2 id="rtoc-6"  class="wp-block-heading">まとめ</h2>



<p class="wp-block-paragraph">FastAPIは、型ヒントベースのバリデーションと自動ドキュメント生成が武器のAPIフレームワークです。このガイドで押さえておきたい点は次のとおりです。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>FastAPIはAPIに特化した軽量フレームワーク。Djangoほどオールインワンではない</li>

<li>最初のハードルはライブラリの組み合わせ・依存関係の把握</li>

<li>ルーティングはデコレータで書き、戻り値がそのままJSONになる</li>
</ul>
</div></div>



<p class="wp-block-paragraph">依存関係さえ乗り越えれば、FastAPIは実は簡単です。プロジェクトで必要になったタイミングで、気負わず触ってみてください。</p>
]]></content:encoded>
					
		
		
			</item>
		<item>
		<title>【FastAPI】API ルーティングの設計について徹底解説！</title>
		<link>https://cfxlog.com/python-fastapi-routing/</link>
		
		<dc:creator><![CDATA[CFXLOG]]></dc:creator>
		<pubDate>Sun, 08 Feb 2026 15:00:00 +0000</pubDate>
				<category><![CDATA[FastAPI]]></category>
		<category><![CDATA[API連携]]></category>
		<guid isPermaLink="false">https://cfxlog.com/?p=4636</guid>

					<description><![CDATA[<p><img src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-routing.jpg" class="webfeedsFeaturedVisual" /></p>このような疑問にお答えします。 FastAPI では関数を使ってルーティングを表現するので、端的で読みやすいです。 本記事ではルーティングにまつわる以下のような内容を解説します。 FastAPIを初めて触る方でも理解しや [&#8230;]]]></description>
										<content:encoded><![CDATA[<p><img src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-routing.jpg" class="webfeedsFeaturedVisual" /></p>
<div class="wp-block-group is-style-crease"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>FastAPI のルーティングの方法が知りたい</li>



<li>バリデーションってどうやるの？</li>
</ul>
</div></div>



<p class="wp-block-paragraph">このような疑問にお答えします。</p>



<p class="wp-block-paragraph">FastAPI では関数を使ってルーティングを表現するので、端的で読みやすいです。</p>



<p class="wp-block-paragraph">本記事ではルーティングにまつわる以下のような内容を解説します。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>各パラメータの見分け方</li>



<li>エンドポイントの作成方法</li>



<li>パスパラメータを扱う方法</li>



<li>リクエストボディを扱う方法</li>



<li>エンドポイントの柔軟性を高める設計のヒント</li>
</ul>
</div></div>



<p class="wp-block-paragraph">FastAPIを初めて触る方でも理解しやすいよう、できるだけ平易に解説していきます。</p>



<div id="rtoc-mokuji-wrapper" class="rtoc-mokuji-content frame2 preset5 animation-fade rtoc_open default" data-id="4636" data-theme="SWELL CHILD">
			<div id="rtoc-mokuji-title" class=" rtoc_left">
			<button class="rtoc_open_close rtoc_open"></button>
			<span>目次</span>
			</div><ol class="rtoc-mokuji mokuji_ol level-1"><li class="rtoc-item"><a href="#rtoc-1">FastAPI での各パラメータの見分け方</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-2">パスパラメータ</a></li><li class="rtoc-item"><a href="#rtoc-3">クエリパラメータ</a></li><li class="rtoc-item"><a href="#rtoc-4">リクエストボディ</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-5">FastAPI におけるエンドポイントの作成方法</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-6">基本的なルート設定方法</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-7">FastAPI でパスパラメータを扱う方法</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#pathparameter-basic">パスパラメータの基本的な使い方</a></li><li class="rtoc-item"><a href="#rtoc-9">２つ以上のパスパラメータを扱う方法</a></li><li class="rtoc-item"><a href="#rtoc-10">パスパラメータにスラッシュを含む場合の対策</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-11">FastAPI でクエリパラメータを扱う方法</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-12">基本的なクエリパラメータの受け取り方</a></li><li class="rtoc-item"><a href="#rtoc-13">クエリパラメータをオプショナルにする</a></li><li class="rtoc-item"><a href="#rtoc-14">クエリパラメータのバリデーション</a></li><li class="rtoc-item"><a href="#rtoc-15">Pydantic を使ったより複雑なバリデーション</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-16">FastAPI でリクエストボディを扱う方法</a></li><li class="rtoc-item"><a href="#rtoc-17">エンドポイントの柔軟性を高める設計のヒント</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-18">リソース指向のアプローチ</a></li><li class="rtoc-item"><a href="#rtoc-19">パスパラメータとクエリパラメータを使い分ける</a></li><li class="rtoc-item"><a href="#rtoc-20">バリデーションとエラー処理の強化</a></li><li class="rtoc-item"><a href="#rtoc-21">バージョニング</a></li><li class="rtoc-item"><a href="#rtoc-22">セキュリティと認証</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-23">API ルーティングの知識を設計に生かそう！</a></li></ol></div><h2 id="rtoc-1"  class="wp-block-heading">FastAPI での各パラメータの見分け方</h2>



<p class="wp-block-paragraph">パラメータには以下の種類があります。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>パスパラメータ</li>



<li>クエリパラメータ</li>



<li>リクエストボディ</li>
</ul>
</div></div>



<p class="wp-block-paragraph">FastAPI のコードは一見するとこれらの違いが分かりにくいので、ここで見分け方を解説します。</p>



<h3 id="rtoc-2"  class="wp-block-heading">パスパラメータ</h3>



<p class="wp-block-paragraph">パスパラメータは、URLのパスの一部として表現されます。</p>



<p class="wp-block-paragraph">つまり<strong>URL 定義をしている部分のうち、波括弧（<code>{}</code>）の中身</strong>がパスパラメータです。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/users/{user_id}")
async def get_user(user_id: int):
    return {"user_id": user_id}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/users/</span><span style="color: #569CD6">{user_id}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">get_user</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">user_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;user_id&quot;</span><span style="color: #D4D4D4">: user_id}</span></span></code></pre></div>



<p class="wp-block-paragraph">上記の例では、<code>user_id</code>がパスパラメータになります。</p>



<p class="wp-block-paragraph">このパスパラメータを関数内で扱うため、「デコレータの波括弧内で宣言した変数名」と同じものを関数の引数として指定しています。</p>



<h3 id="rtoc-3"  class="wp-block-heading">クエリパラメータ</h3>



<p class="wp-block-paragraph">クエリパラメータは URL の<code>?</code>の後に指定されます。<br>Key と Value の組み合わせで表現されるタイプのパラメータです。</p>



<p class="wp-block-paragraph">FastAPI では、<strong>関数の引数がデフォルト値を持つ場合</strong>にクエリパラメータと解釈します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">skip</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">limit</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">10</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;skip&quot;</span><span style="color: #D4D4D4">: skip, </span><span style="color: #CE9178">&quot;limit&quot;</span><span style="color: #D4D4D4">: limit}</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>skip</code>と<code>limit</code>はデフォルト値が設定されているので、どちらもクエリパラメータです。</p>



<p class="wp-block-paragraph">これはフィルタや設定オプションに使われることが多いです。</p>



<h3 id="rtoc-4"  class="wp-block-heading">リクエストボディ</h3>



<p class="wp-block-paragraph">リクエストボディは「リクエストの本体部分に含まれるデータ」で、JSON などの形式で送信されることが多いです。</p>



<p class="wp-block-paragraph">FastAPI では、<strong>Pydantic の BaseModel を継承したクラスを引数とした場合</strong>にリクエストボディと判定されます。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str

@app.post("/items/")
async def create_item(item: Item):
    return item</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> pydantic </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> BaseModel</span></span>
<span class="line"></span>
<span class="line"><span style="color: #569CD6">class</span><span style="color: #D4D4D4"> </span><span style="color: #4EC9B0">Item</span><span style="color: #D4D4D4">(</span><span style="color: #4EC9B0">BaseModel</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    name: </span><span style="color: #4EC9B0">str</span></span>
<span class="line"><span style="color: #D4D4D4">    description: </span><span style="color: #4EC9B0">str</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.post</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">create_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item</span><span style="color: #D4D4D4">: Item):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> item</span></span></code></pre></div>



<p class="wp-block-paragraph">上記の例を見てみると、<code>item</code>という引数は BaseModel を継承した Item クラスを型に指定しています。</p>



<p class="wp-block-paragraph">そのため、<code>item</code>はリクエストボディから取得されます。</p>



<p class="is-style-icon_announce wp-block-paragraph">リクエストボディは POST, PUT メソッドで使われます。</p>



<h2 id="rtoc-5"  class="wp-block-heading">FastAPI におけるエンドポイントの作成方法</h2>



<h3 id="rtoc-6"  class="wp-block-heading">基本的なルート設定方法</h3>



<p class="wp-block-paragraph">FastAPI では「各HTTPメソッドごとに用意されているデコレータ」を使います。</p>



<p class="wp-block-paragraph">非同期通信を行うため、<code>async def</code>を使っていきます。</p>



<p class="is-style-icon_book wp-block-paragraph">パスパラメータやリクエストボディは関数の引数で指定します。</p>



<h4 class="wp-block-heading">GET リクエスト</h4>



<p class="wp-block-paragraph">GET メソッドはリソースを読み出すためのメソッドです。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI


app = FastAPI()

@app.get("/items")
async def read_items():
    return {"message": "GETリクエストを受け取りました"}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">():</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;message&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;GETリクエストを受け取りました&quot;</span><span style="color: #D4D4D4">}</span></span></code></pre></div>



<p class="wp-block-paragraph">リソースに変更を加える場合には、POST メソッド以降を利用します。</p>



<h4 class="wp-block-heading">POST リクエスト</h4>



<p class="wp-block-paragraph">新しいリソースを作成する場合に使われるのが POST メソッドです。</p>



<p class="wp-block-paragraph">以下のように記述することで、POST リクエストに含まれるリクエストボディ<code>item</code>を受け取ることができます。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI


app = FastAPI()

@app.post("/items")
async def create_item(item: dict):
    return {"message": "アイテムを作成しました", "item": item}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.post</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">create_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">dict</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;message&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;アイテムを作成しました&quot;</span><span style="color: #D4D4D4">, </span><span style="color: #CE9178">&quot;item&quot;</span><span style="color: #D4D4D4">: item}</span></span></code></pre></div>



<p class="wp-block-paragraph">受け取ったJSON に対して、便宜的に<code>item</code>という名前をつけたと考えると理解しやすいです。</p>



<p class="wp-block-paragraph">つまり、クライアント側からは POST メソッドで以下のような JSON をリクエストボディに含めることになります。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">JSON</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>{
  "name": "example item",
  "price": 1500
}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #D4D4D4">{</span></span>
<span class="line"><span style="color: #D4D4D4">  </span><span style="color: #9CDCFE">&quot;name&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;example item&quot;</span><span style="color: #D4D4D4">,</span></span>
<span class="line"><span style="color: #D4D4D4">  </span><span style="color: #9CDCFE">&quot;price&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #B5CEA8">1500</span></span>
<span class="line"><span style="color: #D4D4D4">}</span></span></code></pre></div>



<p class="wp-block-paragraph">FastAPI 側ではこの JSON を Python の辞書オブジェクトとして解釈することになります。</p>



<p class="is-style-icon_announce wp-block-paragraph">もちろん「パスパラメータ」や「クエリパラメータ」を含めることもできます。</p>



<h4 class="wp-block-heading">PUT リクエスト</h4>



<p class="wp-block-paragraph">PUT はリソースを作成または置換するために使用されます。<br>リソースがすでにある場合は更新し、ない場合は新規作成します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI


app = FastAPI()

@app.put("/items/{item_id}")
async def update_item(item_id: int, item: dict):
    return {"message": "アイテムを更新しました", "item_id": item_id, "item": item}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.put</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/</span><span style="color: #569CD6">{item_id}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">update_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">item</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">dict</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;message&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;アイテムを更新しました&quot;</span><span style="color: #D4D4D4">, </span><span style="color: #CE9178">&quot;item_id&quot;</span><span style="color: #D4D4D4">: item_id, </span><span style="color: #CE9178">&quot;item&quot;</span><span style="color: #D4D4D4">: item}</span></span></code></pre></div>



<p class="wp-block-paragraph">上記では、「リクエストボディ」と「パスパラメータ」からデータを受け取るようになっています。</p>



<h4 class="wp-block-heading">DELETE リクエスト</h4>



<p class="wp-block-paragraph">DELETE はリソースを削除するメソッドです。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI


app = FastAPI()

@app.delete("/items/{item_id}")
async def delete_item(item_id: int):
    return {"message": "アイテムを削除しました", "item_id": item_id}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.delete</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/</span><span style="color: #569CD6">{item_id}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">delete_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;message&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;アイテムを削除しました&quot;</span><span style="color: #D4D4D4">, </span><span style="color: #CE9178">&quot;item_id&quot;</span><span style="color: #D4D4D4">: item_id}</span></span></code></pre></div>



<p class="wp-block-paragraph">特定の<code>item_id</code>に対してリソースの削除をするコード例になります。</p>



<p class="is-style-icon_info wp-block-paragraph">実際にリソースの削除をするためには、関数内でレコード削除のビジネスロジック追加が必要です。</p>



<h2 id="rtoc-7"  class="wp-block-heading">FastAPI でパスパラメータを扱う方法</h2>



<p class="wp-block-paragraph">パスパラメータは「URL の一部に動的な値」を指定する方法になります。</p>



<p class="wp-block-paragraph">パスパラメータは渡されないと「不完全なURL」とみなされる点には注意が必要です。</p>



<h3 class="wp-block-heading" id="pathparameter-basic">パスパラメータの基本的な使い方</h3>



<p class="wp-block-paragraph">FastAPI では、「デコレータ内」と「関数の引数」でパスパラメータを定義します。</p>



<p class="wp-block-paragraph">以下はパスパラメータとして<code>item_id</code>を定義した例です。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id, "description": "こちらがアイテムの説明です。"}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/</span><span style="color: #569CD6">{item_id}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;item_id&quot;</span><span style="color: #D4D4D4">: item_id, </span><span style="color: #CE9178">&quot;description&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;こちらがアイテムの説明です。&quot;</span><span style="color: #D4D4D4">}</span></span></code></pre></div>



<p class="wp-block-paragraph">関数の引数に型注釈として<code>int</code>が指定されているので、FastAPI は以下のことを行います。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>item_idは整数型に変換される</li>



<li>整数型にできなければエラーを返す</li>
</ul>
</div></div>



<p class="wp-block-paragraph">例えば型注釈として<code>int</code>を指定したにも関わらず &#8220;abc&#8221; を渡した場合には、&#8221;422 Unprocessable Entity&#8221; といステータスコードを返却します。</p>



<div class="swell-block-capbox cap_box is-style-onborder_ttl"><div class="cap_box_ttl"><span>型注釈に指定できるデータ型</span></div><div class="cap_box_content">
<p class="wp-block-paragraph">使えるデータは幅広く、例えば次のようなものがあります。</p>



<ul class="wp-block-list">
<li>Python 標準のデータ型（str, float, list, set など）</li>



<li>Pydantic のデータ型（BaseModel, EmailStr など）</li>



<li>オプショナル型、リテラル型、ユニオン型</li>
</ul>
</div></div>



<h3 id="rtoc-9"  class="wp-block-heading">２つ以上のパスパラメータを扱う方法</h3>



<p class="wp-block-paragraph">複数のパスパラメータを扱う場合も、考え方は同じです。</p>



<p class="wp-block-paragraph">パスパラメータとして<code>user_id</code>と<code>item_id</code>の二つを持つ場合の例を示します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(user_id: int, item_id: int):
    return {"user_id": user_id, "item_id": item_id, "description": "ユーザーとアイテムの情報"}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/users/</span><span style="color: #569CD6">{user_id}</span><span style="color: #CE9178">/items/</span><span style="color: #569CD6">{item_id}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_user_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">user_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">item_id</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;user_id&quot;</span><span style="color: #D4D4D4">: user_id, </span><span style="color: #CE9178">&quot;item_id&quot;</span><span style="color: #D4D4D4">: item_id, </span><span style="color: #CE9178">&quot;description&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;ユーザーとアイテムの情報&quot;</span><span style="color: #D4D4D4">}</span></span></code></pre></div>



<h3 id="rtoc-10"  class="wp-block-heading">パスパラメータにスラッシュを含む場合の対策</h3>



<p class="wp-block-paragraph"><code>/folder1/file1.txt</code>というまとまりをパスパラメータとして取得したい場合を考えてみましょう。</p>



<p class="wp-block-paragraph">普通にコードを書いてしまうと「スラッシュ」が境界線と判断されるので、<code>folder1</code>と<code>file1.txt</code>が別の要素として取得されてしまいます。</p>



<p class="wp-block-paragraph">これを一つのパスパラメータとして扱うには、&#8221;path&#8221; タイプを指定します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/files/{file_path:path}")
async def read_file(file_path: str):
    return {"file_path": file_path}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/files/</span><span style="color: #569CD6">{file_path:path}</span><span style="color: #CE9178">&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_file</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">file_path</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">str</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;file_path&quot;</span><span style="color: #D4D4D4">: file_path}</span></span></code></pre></div>



<p class="wp-block-paragraph">こうすることで<code>file_path</code>に対して<code>/folder1/file1.txt</code>が渡されても、スラッシュで分割されずに要素を取得できることになります。</p>



<h2 id="rtoc-11"  class="wp-block-heading">FastAPI でクエリパラメータを扱う方法</h2>



<p class="wp-block-paragraph">FastAPIでは、関数の引数にデフォルト値を設定することで、クエリパラメータになります。</p>



<p class="wp-block-paragraph">つまり、クエリパラメータが省略された場合にはデフォルト値が使用されます。</p>



<h3 id="rtoc-12"  class="wp-block-heading">基本的なクエリパラメータの受け取り方</h3>



<p class="wp-block-paragraph"><code>skip</code>と<code>limit</code>には初期値を設定したので、それぞれ二つの要素ともクエリパラメータとして扱われます。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">skip</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">limit</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">10</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;skip&quot;</span><span style="color: #D4D4D4">: skip, </span><span style="color: #CE9178">&quot;limit&quot;</span><span style="color: #D4D4D4">: limit}</span></span></code></pre></div>



<p class="wp-block-paragraph">クライアント側から見ると、以下のようなリクエストが送信されることを想定。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Plaintext</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>/items/?skip=20&amp;limit=10</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #D4D4D4">/items/?skip=20&amp;limit=10</span></span></code></pre></div>



<p class="wp-block-paragraph">上記の場合、FastAPI は &#8220;skip&#8221; には &#8220;20&#8221; を、&#8221;limit&#8221; には &#8220;10&#8221; を受け取ることになります。</p>



<h3 id="rtoc-13"  class="wp-block-heading">クエリパラメータをオプショナルにする</h3>



<p class="wp-block-paragraph">オプショナルにするには、初期値として<code>None</code>を指定します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10, tag: Optional&#91;str&#93; = None):
    items = {"skip": skip, "limit": limit}
    if tag:
        items.update({"tag": tag})
    return items</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">skip</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">limit</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">10</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">tag</span><span style="color: #D4D4D4">: Optional&#91;</span><span style="color: #4EC9B0">str</span><span style="color: #D4D4D4">&#93; = </span><span style="color: #569CD6">None</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    items = {</span><span style="color: #CE9178">&quot;skip&quot;</span><span style="color: #D4D4D4">: skip, </span><span style="color: #CE9178">&quot;limit&quot;</span><span style="color: #D4D4D4">: limit}</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">if</span><span style="color: #D4D4D4"> tag:</span></span>
<span class="line"><span style="color: #D4D4D4">        items.update({</span><span style="color: #CE9178">&quot;tag&quot;</span><span style="color: #D4D4D4">: tag})</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> items</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>None</code>を書かない場合、必須のクエリパラメータとなります。</p>



<h3 id="rtoc-14"  class="wp-block-heading">クエリパラメータのバリデーション</h3>



<p class="wp-block-paragraph">型宣言を使用してバリデーションが可能です。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">skip</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">limit</span><span style="color: #D4D4D4">: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = </span><span style="color: #B5CEA8">10</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;skip&quot;</span><span style="color: #D4D4D4">: skip, </span><span style="color: #CE9178">&quot;limit&quot;</span><span style="color: #D4D4D4">: limit}</span></span></code></pre></div>



<p class="wp-block-paragraph">この例では、以下のバリデーションを追加しました。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><code>skip</code>: 整数、デフォルト値は0</li>



<li><code>limit</code>: 整数、デフォルト値は10</li>
</ul>
</div></div>



<p class="wp-block-paragraph">デフォルト値とは、クエリパラメータが渡されない場合の初期値です。</p>



<h3 id="rtoc-15"  class="wp-block-heading">Pydantic を使ったより複雑なバリデーション</h3>



<p class="wp-block-paragraph">Pydanticの <code>Field</code> を使うことで、より複雑なバリデーションを行えます。</p>



<p class="wp-block-paragraph">以下の例は、クエリパラメータで受け取る数値に「最小値」と「最大値」を設定しています</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from pydantic import BaseModel, Field
from typing import Optional

class QueryParams(BaseModel):
    skip: int = Field(default=0, ge=0)
    limit: int = Field(default=10, ge=1, le=100)

@app.get("/items/")
async def read_items(query: QueryParams = Depends()):
    return {"skip": query.skip, "limit": query.limit}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> pydantic </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> BaseModel, Field</span></span>
<span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> typing </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> Optional</span></span>
<span class="line"></span>
<span class="line"><span style="color: #569CD6">class</span><span style="color: #D4D4D4"> </span><span style="color: #4EC9B0">QueryParams</span><span style="color: #D4D4D4">(</span><span style="color: #4EC9B0">BaseModel</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    skip: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = Field(</span><span style="color: #9CDCFE">default</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">ge</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #D4D4D4">    limit: </span><span style="color: #4EC9B0">int</span><span style="color: #D4D4D4"> = Field(</span><span style="color: #9CDCFE">default</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">10</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">ge</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">1</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">le</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">100</span><span style="color: #D4D4D4">)</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_items</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">query</span><span style="color: #D4D4D4">: QueryParams = Depends()):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;skip&quot;</span><span style="color: #D4D4D4">: query.skip, </span><span style="color: #CE9178">&quot;limit&quot;</span><span style="color: #D4D4D4">: query.limit}</span></span></code></pre></div>



<p class="wp-block-paragraph">このコードで行なっていることは以下です。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><code>skip</code>: 0以上</li>



<li><code>limit</code>: 1以上100以下</li>
</ul>
</div></div>



<p class="wp-block-paragraph">ちなみに、数値の比較に使われる名前は以下の意味があるそうです。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><code>ge</code>(&gt;=): greater than or equal</li>



<li><code>gt</code>(&gt;): greater than</li>



<li><code>le</code>(&lt;=): less than or equal </li>



<li><code>lt</code>(&lt;): less than</li>
</ul>
</div></div>



<p class="wp-block-paragraph">どれがどの効果を持つか思い出す際に便利です。</p>



<h2 id="rtoc-16"  class="wp-block-heading">FastAPI でリクエストボディを扱う方法</h2>



<p class="wp-block-paragraph">FastAPI では、リクエストボディに対して複雑なバリデーションを行うことができます。</p>



<p class="wp-block-paragraph">Pydanticモデルを定義して「型宣言」と「バリデーションルール」を組み込むことで対応することになります。</p>



<p class="wp-block-paragraph">以下の例では<code>Item</code>というリクエストボディのバリデーションを行っています。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI
from pydantic import BaseModel, Field

class Item(BaseModel):
    name: str
    description: str = None
    price: float = Field(gt=0, description="The price must be greater than zero")
    tax: float = None

app = FastAPI()

@app.post("/items/")
async def create_item(item: Item):
    return {"name": item.name, "price": item.price}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> pydantic </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> BaseModel, Field</span></span>
<span class="line"></span>
<span class="line"><span style="color: #569CD6">class</span><span style="color: #D4D4D4"> </span><span style="color: #4EC9B0">Item</span><span style="color: #D4D4D4">(</span><span style="color: #4EC9B0">BaseModel</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    name: </span><span style="color: #4EC9B0">str</span></span>
<span class="line"><span style="color: #D4D4D4">    description: </span><span style="color: #4EC9B0">str</span><span style="color: #D4D4D4"> = </span><span style="color: #569CD6">None</span></span>
<span class="line"><span style="color: #D4D4D4">    price: </span><span style="color: #4EC9B0">float</span><span style="color: #D4D4D4"> = Field(</span><span style="color: #9CDCFE">gt</span><span style="color: #D4D4D4">=</span><span style="color: #B5CEA8">0</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">description</span><span style="color: #D4D4D4">=</span><span style="color: #CE9178">&quot;The price must be greater than zero&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #D4D4D4">    tax: </span><span style="color: #4EC9B0">float</span><span style="color: #D4D4D4"> = </span><span style="color: #569CD6">None</span></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.post</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/items/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">create_item</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">item</span><span style="color: #D4D4D4">: Item):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;name&quot;</span><span style="color: #D4D4D4">: item.name, </span><span style="color: #CE9178">&quot;price&quot;</span><span style="color: #D4D4D4">: item.price}</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>Item</code>クラス内の要素の定義は以下です。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><code>name</code>: 必須項目</li>



<li><code>description</code>: オプショナル</li>



<li><code>price</code>: 0より大きい値</li>



<li><code>tax</code>: オプショナル</li>
</ul>
</div></div>



<p class="wp-block-paragraph">初期値ありは必須項目、初期値なしはオプショナル（任意）の項目ということになります。</p>



<p class="wp-block-paragraph">上記のように<code>Field</code>関数を使用すると、詳細なバリデーションルールやメタデータをフィールドに追加できます。</p>



<h2 id="rtoc-17"  class="wp-block-heading">エンドポイントの柔軟性を高める設計のヒント</h2>



<p class="wp-block-paragraph">API をより使いやすくするためのヒントをご紹介します。</p>



<h3 id="rtoc-18"  class="wp-block-heading">リソース指向のアプローチ</h3>



<p class="wp-block-paragraph">各HTTPメソッドの意味に沿った処理内容にしましょう。</p>



<p class="wp-block-paragraph">HTTPメソッドと処理内容の関係は以下の通りです。</p>



<figure class="wp-block-table"><table><thead><tr><th>HTTPメソッド</th><th>処理内容</th></tr></thead><tbody><tr><td><strong>GET</strong></td><td>リソースを読み出すが変更はしない</td></tr><tr><td><strong>POST</strong></td><td>新規リソースを作成</td></tr><tr><td><strong>PUT</strong></td><td>リソースの更新 or 置換</td></tr><tr><td><strong>DELETE</strong></td><td>リソースの削除</td></tr><tr><td><strong>PATCH</strong></td><td>リソースの部分的な更新</td></tr></tbody></table><figcaption class="wp-element-caption">HTTPメソッドの処理内容</figcaption></figure>



<p class="wp-block-paragraph">これらを遵守することで「直感的で分かりやすいエンドポイント」が作成できます。</p>



<p class="is-style-icon_announce wp-block-paragraph">「単一責任の原則」の観点からも重要な事項です。</p>



<h3 id="rtoc-19"  class="wp-block-heading">パスパラメータとクエリパラメータを使い分ける</h3>



<p class="wp-block-paragraph">「パスパラメータ」と「クエリパラメータ」はそれぞれ用途や特性が異なります。</p>



<p class="wp-block-paragraph">基本的には以下の使い分けがされることが多いです。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><strong>パスパラメータ</strong>: リソースの「特定」</li>



<li><strong>クエリパラメータ</strong>：リソースの「操作」</li>
</ul>
</div></div>



<p class="wp-block-paragraph">リソースの特定とは、例えば「ユーザーID」や「製品ID」などを指定して、個別具体的なアイテムを取得してくるイメージです。</p>



<p class="wp-block-paragraph">一方のリソースの「操作」とは、「ページネーション」「フィルタリング」「ソート」などのリソースに対する加工のための追加情報を渡す形になります。</p>



<h3 id="rtoc-20"  class="wp-block-heading">バリデーションとエラー処理の強化</h3>



<p class="wp-block-paragraph">FastAPI では、<strong>Pydantic モデルを使った強力なバリデーションが可能</strong>です。</p>



<p class="wp-block-paragraph">不正 / 不完全なリクエストに適切なエラーを返すことで、システム全体としてのセキュリティを上げていきましょう。</p>



<h3 id="rtoc-21"  class="wp-block-heading">バージョニング</h3>



<p class="wp-block-paragraph">将来的な API の変更に備え、最初からバージョニングを組み込みましょう。</p>



<p class="wp-block-paragraph">URL にバージョン番号を含めることで API の新旧バージョンを並行して運用することや、徐々に移行することもできるようになります。</p>



<h3 id="rtoc-22"  class="wp-block-heading">セキュリティと認証</h3>



<p class="wp-block-paragraph">OAuth2 や JWT を活用し、安全なAPIエンドポイントを作成しましょう。</p>



<h2 id="rtoc-23"  class="wp-block-heading">API ルーティングの知識を設計に生かそう！</h2>



<p class="wp-block-paragraph">FastAPI を使った API ルーティングの基礎をお伝えしてきました。</p>



<p class="wp-block-paragraph">以上の内容を理解して上手に API 設計を行なっていきましょう。</p>
]]></content:encoded>
					
		
		
			</item>
		<item>
		<title>【入門編】FastAPIスピードマスターガイド</title>
		<link>https://cfxlog.com/python-fastapi-quickstart/</link>
		
		<dc:creator><![CDATA[CFXLOG]]></dc:creator>
		<pubDate>Tue, 03 Feb 2026 15:00:00 +0000</pubDate>
				<category><![CDATA[FastAPI]]></category>
		<category><![CDATA[API連携]]></category>
		<guid isPermaLink="false">https://cfxlog.com/?p=4640</guid>

					<description><![CDATA[<p><img src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-quickstart.jpg" class="webfeedsFeaturedVisual" /></p>FastAPI はフルスタックフレームワークの Django に比べると直感的かつシンプルでわかりやすいフレームワークですが、公式チュートリアルを読むのはそれなりの時間もかかります。 そこで FastAPI のエッセンス [&#8230;]]]></description>
										<content:encoded><![CDATA[<p><img src="https://cfxlog.com/wp-content/uploads/2026/03/python-fastapi-quickstart.jpg" class="webfeedsFeaturedVisual" /></p>
<div class="wp-block-group is-style-crease"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li>FastAPIの概要を知りたい</li>



<li>公式チュートリアルを読むのが面倒</li>



<li>簡単な使い方をマスターしたい</li>
</ul>
</div></div>



<p class="wp-block-paragraph">FastAPI はフルスタックフレームワークの Django に比べると直感的かつシンプルでわかりやすいフレームワークですが、公式チュートリアルを読むのはそれなりの時間もかかります。</p>



<p class="wp-block-paragraph">そこで FastAPI のエッセンスをサクッと学べるように、極力ムダを省き爆速でコーディングできるガイドをご用意しました。</p>



<div id="rtoc-mokuji-wrapper" class="rtoc-mokuji-content frame2 preset5 animation-fade rtoc_open default" data-id="4640" data-theme="SWELL CHILD">
			<div id="rtoc-mokuji-title" class=" rtoc_left">
			<button class="rtoc_open_close rtoc_open"></button>
			<span>目次</span>
			</div><ol class="rtoc-mokuji mokuji_ol level-1"><li class="rtoc-item"><a href="#rtoc-1">FastAPIの基本的な使い方</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-2">インストール</a></li><li class="rtoc-item"><a href="#rtoc-3">もっとも簡単なFastAPIのコード</a></li><li class="rtoc-item"><a href="#rtoc-4">ASGIサーバーの起動方法</a></li><li class="rtoc-item"><a href="#rtoc-5">ドキュメントの表示方法</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-6">【重要概念】@appデコレーターについて</a><ul class="rtoc-mokuji mokuji_none level-2"><li class="rtoc-item"><a href="#rtoc-7">ルーティングを行うデコレータ</a></li><li class="rtoc-item"><a href="#rtoc-8">@app.on_eventデコレーター</a></li><li class="rtoc-item"><a href="#rtoc-9">@app.middleware(&#8220;http&#8221;)デコレーター</a></li></ul></li><li class="rtoc-item"><a href="#rtoc-10">まとめ</a></li></ol></div><h2 id="rtoc-1"  class="wp-block-heading">FastAPIの基本的な使い方</h2>



<p class="wp-block-paragraph">いよいよここからは FastAPI を実際に使う手順を解説します。</p>



<p class="wp-block-paragraph">Web 開発にあまり馴染みのない方でも極力わかりやすいように、深掘りして解説していきます。</p>



<h3 id="rtoc-2"  class="wp-block-heading">インストール</h3>



<p class="wp-block-paragraph">次のいずれかのコマンドでライブラリをインストールできます。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Bash</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly># pipでインストールする場合
pip install fastapi uvicorn&#91;statndard&#93;

# Poetryでインストールする場合
poetry add fastapi "uvicorn&#91;standard&#93;"</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #6A9955"># pipでインストールする場合</span></span>
<span class="line"><span style="color: #DCDCAA">pip</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">install</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">fastapi</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">uvicorn&#91;statndard&#93;</span></span>
<span class="line"></span>
<span class="line"><span style="color: #6A9955"># Poetryでインストールする場合</span></span>
<span class="line"><span style="color: #DCDCAA">poetry</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">add</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">fastapi</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">&quot;uvicorn&#91;standard&#93;&quot;</span></span></code></pre></div>



<p class="wp-block-paragraph">uvicorn の後の [standard] をつけることで WebSockets、Gzip、Brotli、HTTP/2 などのサポートが追加されます。基本的につけておくと良いでしょう。</p>



<p class="is-style-icon_info wp-block-paragraph">Poetryで角括弧<code>[]</code>のついたコマンドを実行する際には、シェルが各括弧を特殊な意味で解釈しないように<code>""</code>で囲む必要があるので注意が必要です。</p>



<h4 class="wp-block-heading">uvicornをインストールする理由</h4>



<p class="wp-block-paragraph">FastAPIはASGIサーバー上で動作するので、<strong>ASGIサーバーとして機能するuvicornも同時にインストールする</strong>のが一般的です。</p>



<p class="wp-block-paragraph">ちなみにFastAPIとよく比較されるDjangoでは、伝統的にWSGIサーバー上で動作させることが多いです。ここでASGIとWSGIの違いをざっとまとめておきます。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><strong>ASGI</strong><br>非同期通信に対応しているので、複数のリクエストを同時処理が可能。<br>ウェブソケットなどの長期間の接続もサポート。</li>



<li><strong>WSGI</strong><br>同期処理にしか対応していないので、一度に1つのリクエストしか処理できない。</li>
</ul>
</div></div>



<p class="wp-block-paragraph">つまり、<strong>たくさんのリクエストが集中するようなサービスを作るのであれば非同期処理に対応したASGIの方が優れています</strong>。</p>



<p class="wp-block-paragraph">ただし、WSGIはコードが簡潔で直感的に理解しやすいので、<strong>パフォーマンスを求めなかったり小規模な開発であればかえってWSGIの方が優れている</strong>こともあります。</p>



<h3 id="rtoc-3"  class="wp-block-heading">もっとも簡単なFastAPIのコード</h3>



<p class="wp-block-paragraph">試しに簡単なコードを書いてみましょう。<br>エンドポイントにアクセスすると<code>{"Hello":"World"}</code>とだけ表示されるものです。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

# FastAPIの初期化
app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color: #6A9955"># FastAPIの初期化</span></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.get</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;/&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">read_root</span><span style="color: #D4D4D4">():</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> {</span><span style="color: #CE9178">&quot;Hello&quot;</span><span style="color: #D4D4D4">: </span><span style="color: #CE9178">&quot;World&quot;</span><span style="color: #D4D4D4">}</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>@app.get</code>とすることで、引数内のアドレスにGETメソッドでアクセスがあった場合の動作を定義できます。</p>



<p class="wp-block-paragraph">つまりここではルート（<code>/</code>）にアクセスがあった場合には {Hello: World} を返す、という意味になるわけですね。</p>



<p class="wp-block-paragraph">なお、FastAPI では Python オブジェクトを JSON に変換して返却してくれるという仕様があります。そのためここでは辞書型がリターンされていますが、クライアントには JSON オブジェクトが返されます。</p>



<p class="is-style-icon_info wp-block-paragraph">実際に Hello World を表示させるには、ASGI サーバーを立ち上げる必要があります。</p>



<h3 id="rtoc-4"  class="wp-block-heading">ASGIサーバーの起動方法</h3>



<p class="wp-block-paragraph">ASGIサーバーを立ち上げるコマンドは以下になります。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Bash</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly># コマンドの形式
uvicorn &#91;Pythonファイル名&#93;:&#91;起動するインスタンス名&#93; --reload

# 実際のコマンド例
uvicorn main:app --reload</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #6A9955"># コマンドの形式</span></span>
<span class="line"><span style="color: #DCDCAA">uvicorn</span><span style="color: #D4D4D4"> &#91;Pythonファイル名&#93;:&#91;起動するインスタンス名&#93; --reload</span></span>
<span class="line"></span>
<span class="line"><span style="color: #6A9955"># 実際のコマンド例</span></span>
<span class="line"><span style="color: #DCDCAA">uvicorn</span><span style="color: #D4D4D4"> </span><span style="color: #CE9178">main:app</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">--reload</span></span></code></pre></div>



<p class="wp-block-paragraph"><code>--reload</code>オプションをつけることで開発モードでアプリケーションを起動します。これにより、ソースコードが変更されるたびに uvicorn が再起動して変更内容が反映されます。</p>



<p class="wp-block-paragraph">さて、上記を実行した後にブラウザから<code>https://cfxlog.com/</code>にアクセスしてみてください。動作確認ができるはずです。</p>



<p class="is-style-icon_info wp-block-paragraph">ポートを変更したい場合には<code>--port 8001</code>のように指定することもできます。</p>



<h3 id="rtoc-5"  class="wp-block-heading">ドキュメントの表示方法</h3>



<p class="wp-block-paragraph">FastAPI では Swagger UIと ReDoc により、自動的にドキュメントが作成されます。<br>そのため、例えば開発サーバーを立ち上げている場合は以下の URL にアクセスするだけで簡単にドキュメントを確認できます。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><strong>Swagger UI</strong>：http://localhost:8000/docs</li>



<li><strong>ReDoc</strong>：http://localhost:8000/redoc</li>
</ul>
</div></div>



<p class="wp-block-paragraph">ドキュメントを無効にしたり、エンドポイントを変更するには FastAPI に対して以下のように引数を渡します。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(1 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

# Swagger UI, ReDocを無効化
app_invalidate = FastAPI(docs_url=None, redoc_url=None)

# Swagger UI, ReDocをカスタムパスに変更
app_custompath = FastAPI(docs_url="/custom-docs", redoc_url="/custom-redoc")</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color: #6A9955"># Swagger UI, ReDocを無効化</span></span>
<span class="line"><span style="color: #D4D4D4">app_invalidate = FastAPI(</span><span style="color: #9CDCFE">docs_url</span><span style="color: #D4D4D4">=</span><span style="color: #569CD6">None</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">redoc_url</span><span style="color: #D4D4D4">=</span><span style="color: #569CD6">None</span><span style="color: #D4D4D4">)</span></span>
<span class="line"></span>
<span class="line"><span style="color: #6A9955"># Swagger UI, ReDocをカスタムパスに変更</span></span>
<span class="line"><span style="color: #D4D4D4">app_custompath = FastAPI(</span><span style="color: #9CDCFE">docs_url</span><span style="color: #D4D4D4">=</span><span style="color: #CE9178">&quot;/custom-docs&quot;</span><span style="color: #D4D4D4">, </span><span style="color: #9CDCFE">redoc_url</span><span style="color: #D4D4D4">=</span><span style="color: #CE9178">&quot;/custom-redoc&quot;</span><span style="color: #D4D4D4">)</span></span></code></pre></div>



<h2 id="rtoc-6"  class="wp-block-heading">【重要概念】@appデコレーターについて</h2>



<p class="wp-block-paragraph">FastAPI を理解するための最重要概念は<code>@app</code>デコレーターです。</p>



<p class="wp-block-paragraph">この @app デコレーターにはいくつかの種類があり、それぞれの挙動や使い道を押さえておくと FastAPI による開発の幅が一気に開いていきます。</p>



<h3 id="rtoc-7"  class="wp-block-heading">ルーティングを行うデコレータ</h3>



<p class="wp-block-paragraph">API開発においては、HTTPメソッドをフルに活用して開発が行われます。</p>



<p class="wp-block-paragraph">以下、FastAPI のデコレータとHTTPメソッドの対応関係です。</p>



<figure class="wp-block-table"><table><thead><tr><th>HTTPメソッド</th><th>FastAPI デコレータ</th></tr></thead><tbody><tr><td>GET</td><td>@app.get</td></tr><tr><td>POST</td><td>@app.post</td></tr><tr><td>PUT</td><td>@app.put</td></tr><tr><td>PATCH</td><td>@app.patch</td></tr><tr><td>DELETE</td><td>@app.delete</td></tr></tbody></table><figcaption class="wp-element-caption">デコレータとHTTPメソッドの関係</figcaption></figure>



<p class="wp-block-paragraph">ルーティングについて詳しく知りたい方は、以下の記事も併せてご覧ください。</p>


<div class="swell-block-postLink">投稿が見つかりません。</div>


<p class="wp-block-paragraph">続いては、デコレータの引数について解説します。</p>



<p class="wp-block-paragraph">必須の引数である path の他にも、次のように多数のオプションを設定できます。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><strong>path</strong><br>リクエストを受け取る URL パスを定義します。</li>



<li><strong>response_model</strong><br>エンドポイントから返されるレスポンスのデータ形式を定義します。<br>Pydantic モデルを指定することになります。</li>



<li><strong>status_code</strong><br>成功時の HTTP ステータスコードを指定します。<br>デフォルト値は200番なので、例えば新しいリソースの作成（Create）の場合、&#8221;201&#8243;を指定することが多いです。</li>



<li><strong>tags</strong><br>エンドポイントをグループ分けするためのタグを設定できます。<br>API ドキュメントでグループ化されるので、管理が簡単になります。</li>



<li><strong>summary</strong> と <strong>description</strong><br>APIドキュメントに記載されるエンドポイントの概要と説明を記載します。</li>
</ul>
</div></div>



<h3 id="rtoc-8"  class="wp-block-heading">@app.on_eventデコレーター</h3>



<p class="wp-block-paragraph"><code>@app.on_event</code>デコレーターには二種類の値を設定できます。</p>



<div class="wp-block-group has-border -border01"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained">
<ul class="wp-block-list">
<li><strong>startup</strong><br>アプリの起動時に実行する関数を定義します。<br>例えば、データベース接続の確立や初期化処理を行うために使われます。</li>



<li><strong>shutdown</strong><br>アプリの終了時に実行する関数を定義します。<br>例えば、データベース接続の解放やリソースのクリーンアップ用途に使われます。</li>
</ul>
</div></div>



<p class="wp-block-paragraph">次のサンプルコードはアプリの起動・終了をprintするだけのものです。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI

app = FastAPI()

@app.on_event("startup")
async def startup_event():
    print("アプリケーションが起動しました")

@app.on_event("shutdown")
async def shutdown_event():
    print("アプリケーションが終了しました")</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI</span></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.on_event</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;startup&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">startup_event</span><span style="color: #D4D4D4">():</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #DCDCAA">print</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;アプリケーションが起動しました&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.on_event</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;shutdown&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">shutdown_event</span><span style="color: #D4D4D4">():</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #DCDCAA">print</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;アプリケーションが終了しました&quot;</span><span style="color: #D4D4D4">)</span></span></code></pre></div>



<h3 id="rtoc-9"  class="wp-block-heading">@app.middleware(&#8220;http&#8221;)デコレーター</h3>



<p class="wp-block-paragraph">@app.middleware(&#8220;http&#8221;) デコレーターを使うことで、簡単にミドルウェアの実装ができます。</p>



<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" data-code-block-pro-font-family="Code-Pro-JetBrains-Mono" style="font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#D4D4D4;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)"><span style="display:flex;align-items:center;padding:16px 0 0 16px;width:100%;text-align:left;background-color:#1e1e1e"><span style="background:#c7c7c7;padding:0.3rem 0.5rem 0.2rem;border-radius:1rem;font-size:0.8em;line-height:1;height:1.25rem;text-align:center;display:inline-flex;align-items:center;justify-content:center;color:#1e1e1e">Python</span></span><span role="button" tabindex="0" style="color:#D4D4D4;display:none" aria-label="Copy" class="code-block-pro-copy-button"><pre class="code-block-pro-copy-button-pre" aria-hidden="true"><textarea class="code-block-pro-copy-button-textarea" tabindex="-1" aria-hidden="true" readonly>from fastapi import FastAPI, Request

app = FastAPI()

@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    # リクエストを受けたタイミングでやりたい処理
    ...
    response = await call_next(request)
    # レスポンスを作成した後にやりたい処理
    ...
    response.headers&#91;"Custom-Header"&#93; = "Some value"
    return response</textarea></pre><svg xmlns="http://www.w3.org/2000/svg" style="width:24px;height:24px" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path class="with-check" stroke-linecap="round" stroke-linejoin="round" d="M4.5 12.75l6 6 9-13.5"></path><path class="without-check" stroke-linecap="round" stroke-linejoin="round" d="M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6"></path></svg></span><pre class="shiki dark-plus" style="background-color: #1E1E1E" tabindex="0"><code><span class="line"><span style="color: #C586C0">from</span><span style="color: #D4D4D4"> fastapi </span><span style="color: #C586C0">import</span><span style="color: #D4D4D4"> FastAPI, Request</span></span>
<span class="line"></span>
<span class="line"><span style="color: #D4D4D4">app = FastAPI()</span></span>
<span class="line"></span>
<span class="line"><span style="color: #DCDCAA">@app.middleware</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&quot;http&quot;</span><span style="color: #D4D4D4">)</span></span>
<span class="line"><span style="color: #569CD6">async</span><span style="color: #D4D4D4"> </span><span style="color: #569CD6">def</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">add_process_time_header</span><span style="color: #D4D4D4">(</span><span style="color: #9CDCFE">request</span><span style="color: #D4D4D4">: Request, </span><span style="color: #9CDCFE">call_next</span><span style="color: #D4D4D4">):</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #6A9955"># リクエストを受けたタイミングでやりたい処理</span></span>
<span class="line"><span style="color: #D4D4D4">    ...</span></span>
<span class="line"><span style="color: #D4D4D4">    response = </span><span style="color: #C586C0">await</span><span style="color: #D4D4D4"> call_next(request)</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #6A9955"># レスポンスを作成した後にやりたい処理</span></span>
<span class="line"><span style="color: #D4D4D4">    ...</span></span>
<span class="line"><span style="color: #D4D4D4">    response.headers&#91;</span><span style="color: #CE9178">&quot;Custom-Header&quot;</span><span style="color: #D4D4D4">&#93; = </span><span style="color: #CE9178">&quot;Some value&quot;</span></span>
<span class="line"><span style="color: #D4D4D4">    </span><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> response</span></span></code></pre></div>



<p class="wp-block-paragraph">上記のサンプルコードではレスポンスを返す時にカスタムヘッダーを加える処理を行っています。</p>



<p class="wp-block-paragraph">call_next() 関数は FastAPI で特別な関数で、 response = await call_next(request) とすることでレスポンスが作成されるまで待つことができるようになります。</p>



<p class="wp-block-paragraph">これにより、response = await call_next(request) の前後で処理を書き分けることにより便利に扱うことができるようになります。</p>



<h2 id="rtoc-10"  class="wp-block-heading">まとめ</h2>



<p class="wp-block-paragraph">以上、FastAPI の操作でよく使われるメソッドを中心にご説明してきました。</p>



<p class="wp-block-paragraph">Django などと比べるとかなり直感的に操作ができるので、初めて Web 系の開発にチャレンジしたい方にとってはフレームワークの有力な選択肢になってくるはずです。</p>
]]></content:encoded>
					
		
		
			</item>
	</channel>
</rss>
