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:solid">main.py</u>

  <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span>  正在启动开发服务器 🚀

             从包含 <font color="#3465A4">__init__.py</font> 文件的目录中
             搜索包文件结构
             从 <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font> 导入

   <span style="background-color:#007166"><font color="#D3D7CF"> module </font></span>  🐍 main.py

     <span style="background-color:#007166"><font color="#D3D7CF"> code </font></span>  从模块导入 FastAPI 应用对象，使用以下代码：

             <u style="text-decoration-style:solid">from </u><u style="text-decoration-style:solid"><b>main</b></u><u style="text-decoration-style:solid"> import </u><u style="text-decoration-style:solid"><b>app</b></u>

      <span style="background-color:#007166"><font color="#D3D7CF"> app </font></span>  使用导入字符串: <font color="#3465A4">main:app</font>

   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  服务器已启动于 <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font>
   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  文档位于 <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000/docs</u></font>

      <span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span>  当前运行在开发模式，生产环境请使用:
             <b>fastapi run</b>

             日志:

     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  将监视以下目录中的更改:
             <b>[</b><font color="#4E9A06">&apos;/home/user/code/awesomeapp&apos;</font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Uvicorn 运行于 <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <b>(</b>按 CTRL+C 退出<b>)</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  启动重载进程 <b>[</b><font color="#34E2E2"><b>383138</b></font><b>]</b> 使用 WatchFiles
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  启动服务器进程 <b>[</b><font color="#34E2E2"><b>383153</b></font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  等待应用启动
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  应用启动完成

这个名为 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，这取决于你如何部署应用，你的提供商可能会为你处理，或者你可能需要自己设置。

Tip

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

FastAPI CLI¶

fastapi dev¶

fastapi run¶

`fastapi dev`¶

`fastapi run`¶