如何在FastAPI中使用查询参数进行筛选数据

如何在FastAPI中使用查询参数进行筛选数据

引言：
FastAPI 是一个基于 Python 的现代、快速（高性能）的 Web 框架。它简单易用，同时性能也非常出色。本文将介绍如何在 FastAPI 中使用查询参数进行数据筛选，实现对数据的灵活查询。

一、启动 FastAPI 应用
首先，我们需要创建一个 FastAPI 的应用，并启动它，如下所示：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello, FastAPI!"}

在上述代码中，我们创建了一个 FastAPI 的应用，并定义了一个根路由 /，通过访问根路由，可以返回一条简单的消息“Hello, FastAPI!”。

二、使用查询参数进行数据筛选
在 FastAPI 中，我们可以使用 Query 类型的参数来接收查询参数。下面是一个例子，演示如何使用查询参数进行数据筛选：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/users/")
async def get_users(name: str = Query(None)):
    if name:
        # 根据查询参数 name 进行数据筛选
        result = db.query().filter(User.name == name).all()
    else:
        # 若没有查询参数，则返回所有的用户数据
        result = db.query().all()
    return {"users": result}

在上述代码中，我们定义了一个 /users/ 的路由，通过访问这个路由，可以获取用户数据。该路由接受一个查询参数 name，用于筛选指定名称的用户数据。如果查询参数 name 存在，我们就使用该参数进行数据筛选；否则，返回所有的用户数据。

三、多个查询参数同时使用
在实际场景中，我们可能需要同时根据多个查询参数进行数据筛选。下面是一个示例，演示如何同时使用多个查询参数进行数据筛选：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/users/")
async def get_users(name: str = Query(None), age: int = Query(None)):
    query = db.query()

    if name:
        query = query.filter(User.name == name)

    if age:
        query = query.filter(User.age == age)

    result = query.all()

    return {"users": result}

在上述代码中，我们定义了一个 /users/ 的路由，并接受两个查询参数 name 和 age。我们可以同时根据这两个查询参数进行数据筛选，从而实现更加灵活的查询操作。

四、使用默认值和校验
FastAPI 还支持为查询参数设置默认值，并进行校验。例如，我们可以为 age 查询参数设置默认值为 20，并且限制 age 的取值范围在 10 到 50 之间：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/users/")
async def get_users(name: str = Query(None), age: int = Query(20, ge=10, le=50)):
    query = db.query()

    if name:
        query = query.filter(User.name == name)

    query = query.filter(User.age == age)

    result = query.all()

    return {"users": result}

在上述代码中，我们通过指定 age 查询参数的默认值为 20，并使用 ge 和 le 参数对 age 进行了校验。这样，当请求中不指定 age 查询参数时，会自动使用默认值 20；而当指定 age 查询参数时，会进行取值范围的校验。

结论：
通过上述示例代码，我们了解了如何在 FastAPI 中使用查询参数进行数据筛选。使用查询参数能够为我们的应用增加灵活性，使得我们能够根据具体需求自由地筛选数据。同时，FastAPI 提供了丰富的功能和选项，使得查询参数的使用更加强大和便捷。希望本文能够对你学习和使用 FastAPI 有所帮助。

以上是如何在FastAPI中使用查询参数进行筛选数据的详细内容。更多信息请关注PHP中文网其他相关文章！