【Fastapi 部署】Python 后端开发框架

环境搭建

在 bash/zsh 上运行:

pip3 install fastapi
pip3 install uvicorn

安装完成后,你可以使用以下命令来检查 Uvicorn 的版本,以确保它已正确安装:

uvicorn --version

测试 FastAPI 安装

为了验证 FastAPI 是否安装成功,我们可以创建一个简单的测试代码。在一个新的 Python 文件(例如 test_fastapi.py)中,输入以下内容:

import fastapi

print(fastapi.__version__)

运行这个文件,如果看到 FastAPI 的版本号,那么恭喜你,环境搭建成功!

创建第一个 FastAPI 程序

在你的工作目录中,创建一个新的 Python 文件,命名为 main.py。这个文件将包含我们的 FastAPI 应用代码。

main.py 文件中,输入以下内容:

# main.py
from fastapi import FastAPI
import uvicorn

# 创建一个 FastAPI 实例,这里我们设置了自定义的文档和重文档 URL
app = FastAPI(docs_url="/custom-docs", redoc_url="/custom-redoc")

# 定义一个根路由,当访问根路径时返回一个包含消息的字典
@app.get("/")
async def root():
    return {"message": "Hello 胖鼹鼠"}

# 定义一个带参数的路由,用于获取特定物品 ID 的信息
@app.get("/items/{item_id}")
async def read_item_id(item_id):
    print(item_id)  # 在控制台打印物品 ID
    return {"item_id": item_id}  # 返回一个包含物品 ID 的字典

# 当直接运行此文件时,启动 Uvicorn 服务器
if __name__ == "__main__":
    uvicorn.run(app, host="127.0.0.1", port=8000, reload=True)

启动应用

你可以通过两种方式来启动你的 FastAPI 应用:

  1. 直接运行 Python 文件:在终端中,导航到包含 main.py 的目录,然后运行以下命令:

    python main.py
    

    这将启动服务器,你可以通过浏览器访问 http://127.0.0.1:8000/ 来查看应用的根路由,或者访问 http://127.0.0.1:8000/custom-docs 查看自动生成的文档。

  2. 在 bash/zsh 上运行:你也可以直接使用 Uvicorn 来启动应用。在终端中,运行以下命令:

    uvicorn main:app --host 127.0.0.1 --port 8000 --reload
    

    这里的 main:app 指的是 main.py 文件中的 app 实例。--reload 参数使得服务器在代码更改时自动重启,方便开发。

现在,你已经成功创建并启动了你的第一个 FastAPI 应用!接下来,你可以开始探索 FastAPI 的更多功能,构建更复杂的 API 了。

1 Like