本教程将一步步向你展示如何使用 FastAPI 的绝大部分特性。各个章节的内容循序渐进,但是又围绕着单独的主题,所以你可以直接跳转到某个章节以解决你的特定需求。本教程同样可以作为将来的参考手册,你可以随时回到本教程并查阅你需要的内容。
1. 运行代码
所有代码片段都可以复制后直接使用(它们实际上是经过测试的 Python 文件),要运行任何示例,请将代码复制到 main.py 文件中,然后使用以下命令启动 uvicorn
:
$ uvicorn main:app --reload
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [28720]
INFO: Started server process [28722]
INFO: Waiting for application startup.
INFO: Application startup complete.
强烈建议你在本地编写或复制代码,对其进行编辑并运行。在编辑器中使用 FastAPI 会真正地展现出它的优势:只需要编写很少的代码,所有的类型检查,代码补全等等。
2. 安装FastAPI
第一个步骤是安装 FastAPI,,为了使用本教程,你可能需要安装所有的可选依赖及对应功能:
$ pip install fastapi[all]
上面安装了
uvicorn
,我们可以将其作为运行代码的服务器。
:::info
🔔 注意
————————————
你也可以分开来安装,假如你想将应用程序部署到生产环境,你可能要执行以下操作:pip install fastapi
,并且安装 uvicorn
来作为服务器pip install uvicorn[standard]
,当然你想使用的任意组件也可进行相同的操作。
:::