コンテンツにスキップ

FastAPI CLI

FastAPI CLI は、FastAPI アプリの提供、FastAPI プロジェクトの管理などを行うためのコマンドライン プログラムです。

FastAPI をインストールする際(例:pip install "fastapi[standard]")、fastapi-cli というパッケージが含まれています。このパッケージは、ターミナルで fastapi コマンドを提供します。

開発用に FastAPI アプリを実行するには、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: [&apos;/home/user/code/awesomeapp&apos;]
<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.

fastapi というコマンドライン プログラムは FastAPI CLI です。

FastAPI CLI は、Python プログラムへのパス(例:main.py)を受け取り、FastAPI インスタンス(一般的には app という名前)を自動的に検出し、正しいインポートプロセスを決定し、それを提供します。

本番環境では、代わりに fastapi run を使用します。🚀

内部的には、FastAPI CLI は、高性能で本番環境に対応した ASGI サーバーである Uvicorn を使用しています。😎

fastapi dev

fastapi dev を実行すると、開発モードが開始されます。

デフォルトでは、自動リロードが有効になっており、コードを変更するとサーバーが自動的にリロードされます。これはリソースを大量に消費し、無効にした場合よりも安定性が低下する可能性があります。開発時にのみ使用してください。また、IP アドレス 127.0.0.1(自分自身とのみ通信するためのマシンの IP、localhost)をリッスンします。

fastapi run

fastapi run を実行すると、デフォルトで本番モードで FastAPI が起動します。

デフォルトでは、自動リロードは無効になっています。また、IP アドレス 0.0.0.0(利用可能なすべての IP アドレスを意味します)をリッスンします。このようにして、マシンと通信できるすべての人が公開アクセスできるようになります。これは、通常、本番環境(例:コンテナ内)で実行する方法です。

ほとんどの場合、上部に HTTPS を処理する「終了プロキシ」が必要です(推奨されます)。これは、アプリケーションのデプロイ方法によって異なり、プロバイダーが処理する場合と、自分で設定する必要がある場合があります。

ヒント

詳細については、デプロイメントのドキュメントを参照してください。