Python FastAPI 入门教程：新手快速上手指南

三、FastAPI 的核心魔法：自动文档

这是 FastAPI 最让其他语言开发者羡慕的功能。因为你不需要写任何一行文档代码，FastAPI 已经帮你写好了。

打开浏览器，访问：http://127.0.0.1:8000/docs

你会看到一个 Swagger UI 界面。这是 FastAPI 根据你的代码自动生成的接口文档。 以前：写完接口 -> 打开 Postman -> 填 URL -> 填参数 -> 发送 -> 报错 -> 改代码... 现在：直接在网页上点击 Try it out，填参数，执行。

四、怎么接收数据？（核心基础）

做后端最主要的工作就是：接收前端的数据 -> 处理数据 -> 返回结果。FastAPI 接收数据主要有两种方式，新手必须掌握。

1. 路径参数 (Path Parameters)

场景：你要查询 ID 为 5 的学生信息，网址通常是 http://.../student/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。如果你访问 /student/5，FastAPI 会自动把 5 转换成整数；如果你访问 /student/abc，FastAPI 会直接给你报错，提示你'我们要的是整数，你给的是字符串'。这就是类型检查的强大之处！

2. 查询参数 (Query Parameters)

场景：类似百度的搜索，网址是 http://.../search?keyword=python&page=1。 在 FastAPI 里，只要函数参数里写的变量，没在路径里出现，就是查询参数。

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)

访问 /search?keyword=apple 返回 keyword=apple, page=1 (默认值)。 访问 /search?keyword=apple&page=5 返回 keyword=apple, page=5。

五、最强功能：Pydantic 数据模型

如果你要做注册功能，前端会发来一堆数据（用户名、密码、年龄...）。如果参数太多，一个一个写在函数里太乱了。FastAPI 引入了 Pydantic 来定义数据的'形状'。

from fastapi import FastAPI
import uvicorn
from pydantic import BaseModel

app = FastAPI()

# 1. 导入 BaseModel
# 2. 定义一个类，继承 BaseModel
# 这就像是制定一个'表格'，前端传来的数据必须符合这个表格
class UserInfo(BaseModel):
    username: str
    password: str
    age: int = 18
    is_student: bool = True

# 3. 在接口中使用这个模型
@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)

怎么测试这个 POST 接口？

1. 打开 /docs 文档页面。
2. 找到 /register 接口。
3. 点击 Try it out。
4. 在 Request body 里修改 JSON 数据。
5. 点击 Execute。

你完全不用写解析 JSON 的代码，FastAPI 全部帮你做好了！

六、总结与建议

对于新手来说，掌握以上内容，你已经算是一个合格的 FastAPI 入门者了。

回顾一下今天学到的：

1. 安装：pip install fastapi。
2. 启动：uvicorn 是启动引擎。
3. 文档：/docs 自动生成文档，是测试神器。
4. 参数：利用 Python 的类型提示（int, str）来约束参数。
5. 模型：用 BaseModel 来处理复杂的 POST 数据（如注册登录）。

FastAPI 不仅让你写代码变快，更让你写出规范、健壮的代码。