Python FastAPI 快速入门与实战指南

这个界面是根据你的代码自动生成的。你可以直接在网页上点击 Try it out，填写参数并执行请求，无需借助 Postman 等外部工具。

接收数据的方式

后端开发的核心在于处理前端传来的数据。FastAPI 提供了多种方式来接收参数。

路径参数 (Path Parameters)

当 URL 中包含动态部分时使用，例如查询特定 ID 的用户：/user/5。

from fastapi import FastAPI
import uvicorn

app = FastAPI()

@app.get("/student/{student_id}")
def get_student(student_id: int):
    return {
        "学生 ID": student_id,
        "类型": str(type(student_id))
    }

if __name__ == "__main__":
    uvicorn.run(app="main:app", host="127.0.0.1", port=8088)

注意函数参数中的 student_id: int。这不仅是类型提示，FastAPI 还会进行自动校验。如果访问 /student/abc，框架会直接返回 422 错误，提示期望的是整数而非字符串。

查询参数 (Query Parameters)

用于传递可选参数或搜索条件，例如 ?keyword=python&page=1。

from fastapi import FastAPI
import uvicorn

app = FastAPI()

@app.get("/search")
def search_data(keyword: str, page: int = 1):
    return {
        "你搜的词": keyword,
        "当前页码": page
    }

if __name__ == "__main__":
    uvicorn.run(app="main:app", host="127.0.0.1", port=8088)

未提供的参数会使用默认值（如 page 默认为 1），这在处理分页或筛选时非常有用。

Pydantic 数据模型

当接口需要接收复杂结构的数据（如注册表单）时，逐个定义函数参数会变得混乱。此时应使用 Pydantic 模型来定义数据结构。

from fastapi import FastAPI
import uvicorn
from pydantic import BaseModel

app = FastAPI()

# 定义数据模型
class UserInfo(BaseModel):
    username: str
    password: str
    age: int = 18
    is_student: bool = True

@app.post("/register")
def register(user: UserInfo):
    if user.age < 18:
        return {"message": "未成年人禁止注册", "code": 400}
    return {
        "message": "注册成功",
        "用户": user.username,
        "身份": "学生" if user.is_student else "社会人"
    }

if __name__ == "__main__":
    uvicorn.run(app="main:app", host="127.0.0.1", port=8088)

在 /docs 页面测试该接口时，只需修改 Request body 中的 JSON 数据即可。FastAPI 会自动将 JSON 解析为 UserInfo 对象，并进行字段验证。

总结

掌握以下要点即可开始使用 FastAPI 进行开发：

1. 安装：使用 pip 安装 fastapi 和 uvicorn。
2. 启动：通过 uvicorn 运行 ASGI 应用。
3. 文档：利用 /docs 自动生成接口文档进行测试。
4. 参数：利用类型提示约束路径和查询参数。
5. 模型：使用 BaseModel 处理复杂的 POST 请求体。

FastAPI 不仅提升了开发效率，还通过类型系统保证了代码的健壮性，是现代 Python Web 开发的首选方案之一。