跳至內容

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 使用了 Uvicorn,一個高效能、生產環境就緒的 ASGI 伺服器。 😎

fastapi dev

運行 fastapi dev 會啟動開發模式。

預設情況下,自動重新載入 功能已啟用,當您修改程式碼時,伺服器會自動重新載入。這會消耗資源,並且可能不如停用時穩定。您應該只在開發過程中使用它。它也會監聽 IP 位址 127.0.0.1,這是您的機器僅與自身通訊的 IP 位址 (localhost)。

fastapi run

執行 fastapi run 預設會以生產模式啟動 FastAPI。

預設情況下,自動重新載入 功能已停用。它也會監聽 IP 位址 0.0.0.0,這表示所有可用的 IP 位址,這樣任何可以與該機器通訊的人都可以公開存取它。這是您通常在生產環境中運行它的方式,例如,在容器中。

在大多數情況下,您會(也應該)有一個「終止代理」在頂層為您處理 HTTPS,這將取決於您如何部署您的應用程式,您的供應商可能會為您執行此操作,或者您可能需要自行設定。

提示

您可以在部署文件中了解更多相關資訊。