FastAPI教程查询参数

wencheng

发布于 2022-04-18 13:55:14

6010

发布于 2022-04-18 13:55:14

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

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）时，它们将转换为该类型并针对该类型进行校验。

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

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

默认值

由于查询参数不是路径的固定部分，因此它们可以是可选的，并且可以有默认值。

在上面的示例中，它们具有 skip=0 和 limit=10 的默认值。

因此，访问 URL：

http://127.0.0.1:8000/items/

将与访问以下地址相同：

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

但是，如果你访问的是：

http://127.0.0.1:8000/items/?skip=20

函数中的参数值将会是：

skip=20：在 URL 中设定的值
limit=10：使用默认值

可选参数

通过同样的方式，你可以将它们的默认值设置为 None 来声明可选查询参数：

from typing import Optional
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Optional[str] = None):
    if q:
        return {"item_id": item_id, "q": q}
    return {"item_id": item_id}

在这个例子中，函数参数 q 将是可选的，并且默认值为 None。