FastAPI中的可选查询参数

Question

我不明白 FastAPI 中的可选查询参数。它与默认值为 None 的默认查询参数有何不同？

在下面的示例中，arg1和arg2有什么区别？在该示例中，arg2是一个可选的查询参数，如上面的链接所述。

@app.get("/info/")
async def info(arg1: int = None, arg2: int | None = None):
    return {"arg1": arg1, "arg2": arg2}

Answer 1

这取决于你的看法，但我的哲学是：

可选参数是包含查询参数的较大集合。

也就是说，查询参数采用作为值的输入，而可选参数是可以没有值（即 None）的查询参数。

Answer 2

这在参考手册中有所涉及，尽管只是一个小注释:

async def read_items(q: Optional[str] = None):

FastAPI将知道，由于默认值=无，因此不需要q值。

FastAPI不使用Optional[str]中的Optional，但它将允许您的编辑器为您提供更好的支持并检测错误。

（可选[str]与str|无3.10之前的其他读者相同）

由于您的编辑器可能不知道FastAPI填充和使用参数的上下文，因此当参数未标记为可选时，它可能难以理解函数的实际签名。您可能关心也可能不关心这种区别。