Skip to content

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> 使用路径 <font color="#3465A4">main.py</font>
<font color="#3465A4">INFO    </font> 解析绝对路径 <font color="#75507B">/home/user/code/awesomeapp/</font><font color="#AD7FA8">main.py</font>
<font color="#3465A4">INFO    </font> 从包含 <font color="#3465A4">__init__.py</font> 文件的目录中搜索包文件结构
<font color="#3465A4">INFO    </font> 从 <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font> 导入

 ╭─ <font color="#8AE234"><b>Python 模块文件</b></font> ─╮
 │                      │
 │  🐍 main.py          │
 │                      │
 ╰──────────────────────╯

<font color="#3465A4">INFO    </font> 导入模块 <font color="#4E9A06">main</font>
<font color="#3465A4">INFO    </font> 找到可导入的 FastAPI 应用

 ╭─ <font color="#8AE234"><b>可导入的 FastAPI 应用</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> 使用导入字符串 <font color="#8AE234"><b>main:app</b></font>

 <span style="background-color:#C4A000"><font color="#2E3436">╭────────── FastAPI CLI - 开发模式 ───────────╮</font></span>
 <span style="background-color:#C4A000"><font color="#2E3436">│                                                     │</font></span>
 <span style="background-color:#C4A000"><font color="#2E3436">│  服务地址: 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 文档: 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">│  运行在开发模式,用于生产环境请使用:               │</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>:     将监视这些目录中的更改: [&apos;/home/user/code/awesomeapp&apos;]
<font color="#4E9A06">INFO</font>:     Uvicorn 运行在 <b>http://127.0.0.1:8000</b> (按 CTRL+C 退出)
<font color="#4E9A06">INFO</font>:     启动重载进程 [<font color="#34E2E2"><b>2265862</b></font>] 使用 <font color="#34E2E2"><b>WatchFiles</b></font>
<font color="#4E9A06">INFO</font>:     启动服务器进程 [<font color="#06989A">2265873</font>]
<font color="#4E9A06">INFO</font>:     等待应用启动。
<font color="#4E9A06">INFO</font>:     应用启动完成。

名为 fastapi 的命令行程序是 FastAPI CLI

FastAPI CLI 接受您的 Python 程序的路径(例如 main.py),并自动检测 FastAPI 实例(通常命名为 app),确定正确的导入过程,然后启动它。

对于生产环境,您应该使用 fastapi run 代替。🚀

在内部,FastAPI CLI 使用 Uvicorn,这是一个高性能、生产就绪的 ASGI 服务器。😎

fastapi dev

运行 fastapi dev 启动开发模式。 默认情况下,**自动重载**功能是启用的,当你对代码进行更改时,服务器会自动重新加载。这个功能会消耗大量资源,并且可能不如禁用时稳定。你应该只在开发环境中使用它。它还会监听 127.0.0.1 这个 IP 地址,这是你的机器与自身通信的专用 IP 地址(即 localhost)。

fastapi run

执行 fastapi run 命令会默认以生产模式启动 FastAPI。

默认情况下,**自动重载**功能是禁用的。它还会监听 0.0.0.0 这个 IP 地址,这意味着所有可用的 IP 地址,这样它将对任何能够与机器通信的人公开访问。这就是你通常在生产环境中运行它的方式,例如在容器中。

在大多数情况下,你会(也应该)在顶层有一个“终止代理”来为你处理 HTTPS,这取决于你如何部署应用程序,你的提供商可能会为你处理这个,或者你可能需要自己设置。

Tip

你可以在部署文档中了解更多相关信息。