地旺建设官方网站,哪些网站可以做帮助文档,google推广,wordpress鼠标查询参数
FastAPI官网手册#xff1a;https://fastapi.tiangolo.com/zh/tutorial/query-params/ 上节内容#xff1a;https://skywalk.blog.csdn.net/article/details/143046422
声明的参数不是路径参数时#xff0c;路径操作函数会把该参数自动解释为**查询**参数。 from…查询参数
FastAPI官网手册https://fastapi.tiangolo.com/zh/tutorial/query-params/ 上节内容https://skywalk.blog.csdn.net/article/details/143046422
声明的参数不是路径参数时路径操作函数会把该参数自动解释为**查询**参数。 from fastapi import FastAPIapp 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/?skip0limit10
……查询参数为
skip值为 0limit值为 10
这些值都是 URL 的组成部分因此它们的类型**本应**是字符串。
但声明 Python 类型上例中为 int之后这些值就会转换为声明的类型并进行类型校验。
所有应用于路径参数的流程也适用于查询参数
显而易见的编辑器支持数据解析数据校验API 文档
默认值¶
查询参数不是路径的固定内容它是可选的还支持默认值。
上例用 skip0 和 limit10 设定默认值。
访问 URL
http://127.0.0.1:8000/items/
与访问以下地址相同
http://127.0.0.1:8000/items/?skip0limit10 但如果访问
http://127.0.0.1:8000/items/?skip20
查询参数的值就是
skip20在 URL 中设定的值limit10使用默认值
查看skip和limit不同值的输出
http://192.168.1.5:8000/items/?skip0limit2
[{item_name:Foo},{item_name:Bar}]
http://192.168.1.5:8000/items/?skip1limit2
[{item_name:Bar},{item_name:Baz}] http://192.168.1.5:8000/items/?skip1limit1
[{item_name:Bar}]
也就是skip和limit是fake_items_db里面的切片参数代码为fake_items_db[skip : skip limit] 可选参数¶
同理把默认值设为 None 即可声明**可选的**查询参数
from fastapi import FastAPIapp 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}
本例中查询参数 q 是可选的默认值为 None。
注意FastAPI 可以识别出 item_id 是路径参数q 不是路径参数而是查询参数。
因为默认值为 NoneFastAPI 把 q 识别为可选参数。
FastAPI 不使用 Optional[str] 中的 Optional只使用 str但 Optional[str] 可以帮助编辑器发现代码中的错误。
查询参数类型转换¶
参数还可以声明为 bool 类型FastAPI 会自动转换参数类型
from fastapi import FastAPIapp 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
本例中访问
http://127.0.0.1:8000/items/foo?short1
或
http://127.0.0.1:8000/items/foo?shortTrue
或
http://127.0.0.1:8000/items/foo?shorttrue
或
http://127.0.0.1:8000/items/foo?shorton
或
http://127.0.0.1:8000/items/foo?shortyes
或其它任意大小写形式大写、首字母大写等函数接收的 short 参数都是布尔值 True。值为 False 时也一样。
多个路径和查询参数¶
FastAPI 可以识别同时声明的多个路径参数和查询参数。
而且声明查询参数的顺序并不重要。
FastAPI 通过参数名进行检测
from fastapi import FastAPIapp 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
必选查询参数¶
为不是路径参数的参数声明默认值至此仅有查询参数该参数就**不是必选**的了。
如果只想把参数设为**可选**但又不想指定参数的值则要把默认值设为 None。如果要把查询参数设置为**必选**就不要声明默认值
from fastapi import FastAPIapp 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: [ { loc: [ query, needy ], msg: field required, type: value_error.missing } ] }
needy 是必选参数因此要在 URL 中设置值
http://127.0.0.1:8000/items/foo-item?needysooooneedy
……这样就正常了
{ item_id: foo-item, needy: sooooneedy }
当然把一些参数定义为必选为另一些参数设置默认值再把其它参数定义为可选这些操作都是可以的
from fastapi import FastAPIapp 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
本例中有 3 个查询参数
needy必选的 str 类型参数skip默认值为 0 的 int 类型参数limit可选的 int 类型参数
在浏览器中打开如下地址
http://127.0.0.1:8000/items/5?needyok
返回
{item_id:5,needy:ok,skip:0,limit:null} 实践略
