教程 - 用户指南
本教程将逐步展示如何使用 FastAPI 的大部分功能。
每个部分都逐步建立在之前的内容之上,但结构上分开了各个主题,因此你可以直接跳到任何特定的部分来解决你的特定 API 需求。
它也被设计为未来的参考,因此你可以随时回来查看你需要的具体内容。
运行代码
所有代码块都可以直接复制并使用(它们实际上是经过测试的 Python 文件)。
要运行任何示例,请将代码复制到 main.py
文件中,并使用以下命令启动 fastapi dev
:
fast → fastapi dev main.py INFO 使用路径 main.py INFO 解析绝对路径 /home/user/code/awesomeapp/ main.py INFO 从包含 __init__.py 文件的目录中搜索包文件结构INFO 从 /home/user/code/ awesomeapp 导入 ╭─ Python 模块文件 ─╮ │ │ │ 🐍 main.py │ │ │ ╰──────────────────────╯INFO 导入模块 main INFO 找到可导入的 FastAPI 应用 ╭─ 可导入的 FastAPI 应用 ─╮ │ │ │ from main import app │ │ │ ╰──────────────────────────╯INFO 使用导入字符串 main:app ╭────────── FastAPI CLI - 开发模式 ───────────╮ │ │ │ 服务地址: http://127.0.0.1:8000 │ │ │ │ API 文档: http://127.0.0.1:8000/docs │ │ │ │ 运行在开发模式,用于生产环境请使用: │ │ │ fastapi run │ │ │ ╰─────────────────────────────────────────────────────╯ INFO : 将监视这些目录中的更改: ['/home/user/code/awesomeapp']INFO : Uvicorn 运行在 http://127.0.0.1:8000 (按 CTRL+C 退出)INFO : 启动重载进程 [2265862 ] 使用 WatchFiles INFO : 启动服务器进程 [2265873 ]INFO : 等待应用启动。INFO : 应用启动完成。restart ↻
**强烈建议**你编写或复制代码,编辑并本地运行。
在编辑器中使用它,才能真正体会到 FastAPI 的好处,看到你只需编写很少的代码,所有的类型检查、自动补全等。
安装 FastAPI
第一步是安装 FastAPI。
确保你创建了一个 虚拟环境 ,激活它,然后**安装 FastAPI**:
Note
当你使用 pip install "fastapi[standard]"
安装时,它会附带一些默认的可选标准依赖项。
如果你不想安装这些可选依赖项,可以选择安装 pip install fastapi
。
高级用户指南
还有一个 高级用户指南 ,你可以在阅读完这个 教程 - 用户指南 之后再阅读。
高级用户指南 建立在这个指南的基础上,使用相同概念,并教你一些额外的功能。
但你应该首先阅读 教程 - 用户指南 (你现在正在阅读的内容)。
它的设计让你可以仅使用 教程 - 用户指南 构建一个完整的应用程序,然后根据你的需求,使用 高级用户指南 中的一些额外想法来扩展它。