チュートリアル - ユーザーガイド¶
このチュートリアルでは、FastAPIのほとんどの機能を段階的に使用する方法を示します。
各セクションは前のセクションに基づいて段階的に構築されますが、トピックを分けて構成されているため、特定のAPIニーズを解決するために、特定のセクションに直接進むことができます。
また、将来の参照として機能するように構築されているため、必要なものを見つけるために戻ってくることができます。
コードの実行¶
すべてのコードブロックはコピーして直接使用できます（実際にはテスト済みのPythonファイルです）。
例を実行するには、コードをmain.pyファイルにコピーし、以下を使用してfastapi devを開始します。
$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:single">main.py</u>
<font color="#3465A4">INFO </font> Using path <font color="#3465A4">main.py</font>
<font color="#3465A4">INFO </font> Resolved absolute path <font color="#75507B">/home/user/code/awesomeapp/</font><font color="#AD7FA8">main.py</font>
<font color="#3465A4">INFO </font> Searching for package file structure from directories with <font color="#3465A4">__init__.py</font> files
<font color="#3465A4">INFO </font> Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font>
╭─ <font color="#8AE234"><b>Python module file</b></font> ─╮
│ │
│ 🐍 main.py │
│ │
╰──────────────────────╯
<font color="#3465A4">INFO </font> Importing module <font color="#4E9A06">main</font>
<font color="#3465A4">INFO </font> Found importable FastAPI app
╭─ <font color="#8AE234"><b>Importable FastAPI app</b></font> ─╮
│ │
│ <span style="background-color:#272822"><font color="#FF4689">from</font></span><span style="background-color:#272822"><font color="#F8F8F2"> main </font></span><span style="background-color:#272822"><font color="#FF4689">import</font></span><span style="background-color:#272822"><font color="#F8F8F2"> app</font></span><span style="background-color:#272822"> </span> │
│ │
╰──────────────────────────╯
<font color="#3465A4">INFO </font> Using import string <font color="#8AE234"><b>main:app</b></font>
<span style="background-color:#C4A000"><font color="#2E3436">╭────────── FastAPI CLI - Development mode ───────────╮</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ Serving at: http://127.0.0.1:8000 │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ API docs: http://127.0.0.1:8000/docs │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ Running in development mode, for production use: │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ </font></span><span style="background-color:#C4A000"><font color="#555753"><b>fastapi run</b></font></span><span style="background-color:#C4A000"><font color="#2E3436"> │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">╰─────────────────────────────────────────────────────╯</font></span>
<font color="#4E9A06">INFO</font>: Will watch for changes in these directories: ['/home/user/code/awesomeapp']
<font color="#4E9A06">INFO</font>: Uvicorn running on <b>http://127.0.0.1:8000</b> (Press CTRL+C to quit)
<font color="#4E9A06">INFO</font>: Started reloader process [<font color="#34E2E2"><b>2265862</b></font>] using <font color="#34E2E2"><b>WatchFiles</b></font>
<font color="#4E9A06">INFO</font>: Started server process [<font color="#06989A">2265873</font>]
<font color="#4E9A06">INFO</font>: Waiting for application startup.
<font color="#4E9A06">INFO</font>: Application startup complete.
</pre>
コードを書き写したり、コピーして編集し、ローカルで実行することを強くお勧めします。
エディタで使用する方が、FastAPIの利点を本当に理解できます。記述するコードの量が少なく、型チェック、自動補完などがどのように機能するかを確認できます。
FastAPIのインストール¶
最初のステップはFastAPIをインストールすることです。
仮想環境を作成し、それをアクティブにしてから、FastAPIをインストールしてください。
$ pip install "fastapi[standard]"
---> 100%
注記
pip install "fastapi[standard]"でインストールすると、いくつかのデフォルトのオプションの標準依存関係が付属します。
これらのオプションの依存関係を必要としない場合は、代わりにpip install fastapiをインストールできます。
上級ユーザーガイド¶
このチュートリアル - ユーザーガイドの後で、後で読むことができる上級ユーザーガイドもあります。
上級ユーザーガイドはこれに基づいて構築され、同じ概念を使用し、追加の機能について説明します。
しかし、まずチュートリアル - ユーザーガイド（今読んでいるもの）を読んでください。
チュートリアル - ユーザーガイドだけで完全なアプリケーションを構築し、必要に応じて上級ユーザーガイドの追加のアイデアの一部を使用して、さまざまな方法で拡張できるように設計されています。