查询参数¶

当你声明了不属于路径参数的函数参数时，它们将被自动解析为“查询”参数。

Python 3.8+

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 即可：

Python 3.10+

from fastapi import FastAPI

app = FastAPI()


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

🤓 其他版本和变体

Python 3.8+

from typing import Union

from fastapi import FastAPI

app = FastAPI()


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

在这种情况下，函数参数 q 将是可选的，且默认值为 None。

检查

另外请注意，FastAPI 足够智能，可以识别出路径参数 item_id 是一个路径参数，而 q 不是，所以它是一个查询参数。

查询参数的类型转换¶

你还可以声明 bool 类型，它们也会被转换：

Python 3.10+

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: str, q: str | None = None, short: bool = False):
    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

🤓 其他版本和变体

Python 3.8+

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Union[str, None] = None, short: bool = False):
    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

在这种情况下，如果你访问：

http://127.0.0.1:8000/items/foo?short=1

或者

http://127.0.0.1:8000/items/foo?short=True

或者

http://127.0.0.1:8000/items/foo?short=true

或者

http://127.0.0.1:8000/items/foo?short=on

或者

http://127.0.0.1:8000/items/foo?short=yes

或任何其他的大小写变体（例如大写，首字母大写等），你的函数将看到参数 short 的 bool 值为 True。否则为 False。

多个路径参数和查询参数¶

你可以同时声明多个路径参数和查询参数，FastAPI 知道哪个是哪个。

而且你不需要以任何特定的顺序声明它们。

它们将通过名称被检测到：

Python 3.10+

from fastapi import FastAPI

app = FastAPI()


@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(
    user_id: int, item_id: str, q: str | None = None, short: bool = False
):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

🤓 其他版本和变体

Python 3.8+

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(
    user_id: int, item_id: str, q: Union[str, None] = None, short: bool = False
):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

必需的查询参数¶

当你为非路径参数（到目前为止，我们只看到了查询参数）声明了默认值时，那么它就不是必需的。

如果你不想添加一个特定的值，而只是想让它成为可选的，可以将默认值设置为 None。

但当你想让一个查询参数成为必需的时，你可以不声明任何默认值：

Python 3.8+

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_user_item(item_id: str, needy: str):
    item = {"item_id": item_id, "needy": needy}
    return item

这里，查询参数 needy 是一个类型为 str 的必需查询参数。

如果你在浏览器中打开一个类似下面的 URL：

http://127.0.0.1:8000/items/foo-item

...而没有添加必需的参数 needy，你将会看到类似下面的错误：

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "query",
        "needy"
      ],
      "msg": "Field required",
      "input": null
    }
  ]
}

由于 needy 是一个必需的参数，你需要在 URL 中设置它：

http://127.0.0.1:8000/items/foo-item?needy=sooooneedy

...这样就可以工作了：

{
    "item_id": "foo-item",
    "needy": "sooooneedy"
}

当然，你也可以定义一些必需的参数，一些带有默认值的参数，以及一些完全可选的参数：

Python 3.10+

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_user_item(
    item_id: str, needy: str, skip: int = 0, limit: int | None = None
):
    item = {"item_id": item_id, "needy": needy, "skip": skip, "limit": limit}
    return item

🤓 其他版本和变体

Python 3.8+

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_user_item(
    item_id: str, needy: str, skip: int = 0, limit: Union[int, None] = None
):
    item = {"item_id": item_id, "needy": needy, "skip": skip, "limit": limit}
    return item

在这种情况下，有 3 个查询参数：

needy，一个必需的 str。
skip，一个默认值为 0 的 int。
limit，一个可选的 int。

提示

你也可以像在路径参数中一样使用 Enum。