教程 - 用户指南¶
本教程将逐步向您展示如何使用 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。
高级用户指南¶
您还可以阅读稍后阅读的高级用户指南，以了解本教程 - 用户指南。
高级用户指南在此基础上构建，使用相同的概念，并教您一些额外的功能。
但您应该首先阅读教程 - 用户指南（您现在正在阅读的内容）。
它的设计使得您只需使用教程 - 用户指南即可构建一个完整的应用程序，然后根据您的需求以不同的方式扩展它，使用高级用户指南中的一些其他想法。