FastAPI-5-查询参数

不属于路径参数时，它们将被自动解释为"查询字符串"参数

from fastapi import FastAPI

app = FastAPI()

fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]


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

 

查询字符串是键值对的集合，这些键值对位于 URL 的 ？ 之后，并以 & 符号分隔。

例如，在以下 url 中：

http://127.0.0.1:8000/items/?skip=0&limit=10

...查询参数为：

• skip：对应的值为 0
• limit：对应的值为 10

由于它们是 URL 的一部分，因此它们的"原始值"是字符串。

但是，当你为它们声明了 Python 类型（在上面的示例中为 int）时，它们将转换为该类型并针对该类型进行校验。

应用于路径参数的所有相同过程也适用于查询参数：

• （很明显的）编辑器支持
• 数据"解析"
• 数据校验
• 自动生成文档