查询参数概念
当声明不属于路径参数的其他函数参数时,它们将自动解释为“Query”参数,也就是查询参数
查询参数就是一系列在URL?之后的key-value键值对,每对键值对用 & 分割开来
由于它们都是URL的一部分,所以 “本质上” 它们都是字符串
但是当需要使用Python类型来声明query参数的时候(例如用int),他们就会被转换为相应的类型并且依据这个类型来验证传入参数
适用于Path参数的所有过程也适用于Query参数
@app.get("/files/")
def add(num1: int=2, num2 int=8):
return {"num1 + num2 = ": num1 + num2}
当你使用浏览器访问http://127.0.0.1:8000/files/?num1=2&num2=3,你会得到:{"num1 + num2 = ":5}
给查询参数设置默认值
query参数类不是path中固定的一部分,所以他们是可选的,并且可以有默认值
例如上面的例子,当使用浏览器访问http://127.0.0.1:8001/files/,你会得到:{"num1 + num2 = ":10}
设置可选的查询参数
声明可选的Query参数,只需要将他们的默认值设置为None即可
- 如果设置的查询参数没有默认值不是None,那么这个查询参数就是必需查询参数,必须要传入,否则会报错
- 查询参数可以和路径参数结合使用
@app.get("/files/")
def add(num1: int = 2, num2: int = 8, num3: int = None):
return {"num1 + num2 =": num1 + num2 + num3 if num3 is not None else num1 + num2}