FastAPI FastAPI中的可选查询参数

在本文中，我们将介绍FastAPI中的可选查询参数的使用方法和示例。

FastAPI可选查询参数

在FastAPI中，可选查询参数允许我们向API发送请求时提供一些可选的参数，而不是所有参数都是必需的。这样可以使API更加灵活和易于使用。

在FastAPI中，我们可以使用Optional来定义可选查询参数。Optional是Pydantic模块中的一个类，用于指定参数可以是可选的。在我们定义的路径操作函数中使用Optional类，并将参数名作为其类型注解即可。

以下是一个使用可选查询参数的示例：

from fastapi import FastAPI
from typing import Optional

app = FastAPI()

@app.get("/items/")
async def read_items(skip: Optional[int] = 0, limit: int = 10):
    items = get_items_from_database()
    return items[skip : skip + limit]

在上述示例中，read_items路径操作函数中定义了一个可选的skip参数和一个必需的limit参数。skip参数的类型注解为Optional[int]，表示skip参数可以是可选的。limit参数没有使用Optional类来定义，因此它是必需的。

在调用该API时，我们可以省略skip参数，如果省略该参数，则使用默认值0。以下是几个调用示例：
– /items/?skip=10：跳过前10个项，返回10个项。
– /items/：与/items/?skip=0相同，返回前10个项。
– /items/?limit=5：返回前5个项，不跳过任何项。
– /items/?skip=5&limit=5：跳过前5个项，返回接下来的5个项。

使用多个可选查询参数

我们还可以在FastAPI中使用多个可选查询参数。只需在路径操作函数中定义多个使用Optional类的参数即可。

以下是一个使用多个可选查询参数的示例：

from fastapi import FastAPI
from typing import Optional

app = FastAPI()

@app.get("/users/")
async def get_users(name: Optional[str] = None, age: Optional[int] = None):
    users = get_users_from_database()
    filtered_users = []

    for user in users:
        if name and name != user.name:
            continue
        if age and age != user.age:
            continue
        filtered_users.append(user)

    return filtered_users

在上述示例中，get_users路径操作函数定义了两个可选的查询参数name和age，它们的类型注解分别为Optional[str]和Optional[int]。

调用该API时，我们可以选择性地提供name和age参数来过滤用户。以下是几个调用示例：
– /users/：返回所有用户。
– /users/?name=John：返回名为John的用户。
– /users/?age=25：返回年龄为25的用户。
– /users/?name=John&age=25：返回名为John且年龄为25的用户。

总结

本文介绍了FastAPI中可选查询参数的使用方法和示例。我们可以使用Optional类来定义可选查询参数，并在路径操作函数中使用它们。这使得API更加灵活和易于使用，可以根据需要选择性地提供参数。通过示例，我们展示了如何在FastAPI中使用可选查询参数以及如何处理多个可选查询参数。这些功能使得我们能够构建出更加强大和高度可定制的API。

希望本文对你理解和使用FastAPI的可选查询参数有所帮助！