FastAPI入门教程：路径参数详解

概述

欢迎来到FastAPI的精彩世界！如果你已经掌握基础Python语法，但对Web开发还感到陌生，别担心——从今天开始，我们将一起学习FastAPI中的路径参数。想象一下，路径参数就像是地图上的地标坐标：URL的一部分，用于精确定位某个资源。例如，在网站/users/123中，123就是一个路径参数，表示ID为123的用户。学会使用路径参数，你就能轻松创建动态的、个性化的API，迈向Web开发的第一步。

什么是路径参数？

路径参数是嵌入在URL中的变量，用于捕获特定部分的值，让API能够处理不同输入。在FastAPI中，你可以直接定义这些参数，它们会自动转换成Python类型，如整数、字符串等，极大地简化了开发流程。

生活化类比

把路径参数比作手机通讯录：URL就像是通讯录的主页，而路径参数就像具体的联系人姓名，每个姓名对应一个独一无二的联系方式和信息。当你输入特定名称时，系统就能快速找到并展示相关详情。

定义路径参数

在FastAPI中，定义路径参数非常简单直观。使用花括号{}在路由中声明参数，然后在函数参数中指定其类型。

成功时刻：第一个路径参数示例

让我们动手创建一个FastAPI应用，体验定义路径参数的乐趣。首先，确保安装必要的包：

pip install fastapi uvicorn

创建一个名为main.py的文件，输入以下代码：

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/{user_id}")
async def read_user(user_id: int):
    return {"user_id": user_id}

运行应用：

uvicorn main:app --reload

打开浏览器，访问http://127.0.0.1:8000/users/123，你会立即看到输出{"user_id": 123}。太棒了！你已经成功创建了第一个带路径参数的API端点，感受到了FastAPI的便捷。

类型转换

FastAPI的强大之处在于自动类型转换。在定义函数参数时，指定类型如int、str等，FastAPI会智能地将URL中的字符串转换为对应Python类型，无需手动处理。

更多成功时刻：不同类型示例

• 字符串转换：创建一个简单的问候端点。

@app.get("/greet/{name}")
async def greet(name: str):
    return {"message": f"Hello, {name}!"}

访问http://127.0.0.1:8000/greet/John，输出{"message": "Hello, John!"}，体验即时成功感。

• 浮点数转换：假设需要处理价格。

@app.get("/prices/{price}")
async def show_price(price: float):
    return {"price": price}

访问http://127.0.0.1:8000/prices/19.99，输出{"price": 19.99}，感受自动转换的便利。 通过这些例子，你会发现FastAPI让类型转换变得像喝水一样简单。

验证路径参数

为了确保数据安全，路径参数往往需要验证。FastAPI内置了验证机制，通过类型提示和Path装饰器，可以轻松添加限制条件。

成功时刻：基础验证示例

假设你想限制用户ID在1到100之间，以防止无效输入。使用Path来添加验证：

from fastapi import FastAPI, Path

app = FastAPI()

@app.get("/users/{user_id}")
async def read_user(user_id: int = Path(..., ge=1, le=100)):
    return {"user_id": user_id}

• Path(..., ge=1, le=100)：...表示必填参数，ge和le分别设置最小值和最大值。 现在，访问http://127.0.0.1:8000/users/50，成功返回{"user_id": 50}。尝试输入无效值，如http://127.0.0.1:8000/users/0或http://127.0.0.1:8000/users/abc，FastAPI会自动返回清晰的错误信息，保护你的API免受恶意输入。这又是一个自信满满的时刻！

扩展实践：路径参数组合

学会单个参数后，挑战一下多个路径参数，感受动态路由的魅力。

@app.get("/products/{product_id}/reviews/{review_id}")
async def get_review(product_id: int, review_id: int):
    return {"product_id": product_id, "review_id": review_id}

访问http://127.0.0.1:8000/products/5/reviews/2，输出{"product_id": 5, "review_id": 2}，体验处理复杂URL的成就感。

总结与鼓励

通过本教程，你掌握了FastAPI路径参数的核心：定义、类型转换和验证。我们从简单的类比入手，一步步动手实践，享受了多个“成功时刻”。记住，路径参数只是FastAPI的冰山一角——它还有查询参数、请求体等更多功能等待探索。继续保持动手实践的习惯，你很快就能自信地构建更复杂的Web应用。

现在，你已经迈出了Web开发的第一步。试着修改示例代码，添加自己的创意，比如用路径参数来模拟一个小型博客系统。实践出真知，加油！