3. fastApi查询参数详解

2023-05-16

当声明的参数不是路径参数时,路径操作函数会把该参数自动解释为查询参数。如下:路径操作函数将参数skip limit解释为查询参数 query_parameter

@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):

查询参数的介绍与常见使用场景

查询参数(Query parameters)是在URL中添加的键值对,用于向服务器发送附加的参数信息。它们通常用于筛选、排序、分页和搜索等功能。查询参数以问号(?)开始,后面跟着一个或多个键值对,每个键值对之间使用“&”符号进行分隔。例如,以下URL包含两个查询参数:

https://www.example.com/search?q=books&sort=price

其中,“q”是键,对应的值是“books”,表示查询的关键词是“books”;“sort”是键,对应的值是“price”,表示搜索结果按价格排序。

查询参数的用法主要包括:

筛选数据:可以通过查询参数来筛选所需的数据。例如,在电商网站中,可以使用“category”参数来筛选商品分类。

分页:可以使用“page”和“size”等参数来控制分页。例如,“page=2&size=10”表示返回第2页,每页包含10条结果。

搜索:可以使用“q”参数来指定搜索关键词,以便搜索引擎返回相关结果。

排序:可以使用“sort”参数来指定排序方式,例如按价格、评分等排序。

其他:查询参数还可以用于其他自定义功能,例如限制返回结果的数量、选择返回结果的字段等。

使用查询参数可以方便地传递附加的参数信息,以便服务器返回符合要求的数据。同时,查询参数还可以缓存结果,从而提高性能和响应速度

fastApi示例

实现分页查询功能

目标:接口路径为/query,接受查询参数page和limit,其中page默认为1,limit为可选参数,默认为10
实现代码:

from typing import Optional
@app03.get("/query")
def page_limit(page: int = 1, limit: Optional[int] = 10): 
# def page_limit(page: int, limit: Optional[int] = 10):  # 给了默认值就是选填的参数,没给默认值就是必填参数
    return {"page": page, "limit": limit}

最终结果
在这里插入图片描述

布尔类型转换

说明:当前端传递查询参数到后端时,参数值【yes on 1 True true】可以转换成true, 其它可以转换false(当试图函数接受的查询参数为bool类型时)

@app03.get("/query/bool/conversion")
def type_conversion(param: bool = False):
    return param

Query类校验查询参数

说明:可以使用Query方法对查询参数中的【字符串,数组】进行校验,主要校验字符串的长度,字符串的开头,同时为参数添加描述,便于通过api查看
示例代码:

@app03.get("/query/validations")  # 长度+正则表达式验证,比如长度8-16位,以a开头。其它校验方法看Query类的源码
def query_params_validate(
        # value: str = Query(..., min_length=8, max_length=16, regex="^a"),  # ...换成None就变成选填的参数
        # value: str = Query(None, min_length=8, max_length=16, regex="^a"),
        # 使用default为数据设置默认值,使用alias为参数设置别名,使用description设置描述介绍
        value: str = Query(default="ahelloworld",alias="字符串查询参数示例",description="这是描述",min_length=8, max_length=16, regex="^a"),
        values: List[str] = Query(["v1", "v2"], alias="alias_name")
):  # 多个查询参数的列表。参数别名
    return value, values

实现效果:
在这里插入图片描述
解释:通过Query方法校验查询参数,限制了字符串的长度,同时使用正则过滤查询参数的开头。
Query方法在大多数情况下用于过滤查询参数中的字符串

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

3. fastApi查询参数详解 的相关文章

随机推荐

  • #C++#通过libcurl获取当前次HTTP请求的一些相关信息

    libcurl库是一个非常完整和好用的HTTP请求库 xff0c 通过它 xff0c 我们可以方便的书写HTTP请求程序 xff0c 而且不需要关心HTTP协议内部的细节处理 最近在做一个HTTP监测的程序 xff0c 就是通过libcur
  • 运行Maven Web项目出现 org.eclipse.jdt.internal.compiler.classfmt.ClassFormatException错误

    异常问题描述 xff1a 初学Maven xff0c 新建了一个基于Web骨架的Web项目 xff0c jar 包也导好了 xff0c 作用域也设置正确了 xff0c Tomcat也正常运行了 xff0c 可是就是说编译错误 问题原因 由于
  • 解决mingw-w64外网下载太慢问题,离线包安装配置过程讲解

    常规安装程序下载地址 xff1a http www mingw w64 org doku php 但用安装程序直接安装mingw w64 xff0c 由于国际网络链路问题 xff0c 很难安装成功 xff0c 于是做了打包了一个离线包 xf
  • HTTP安全-nonce和timestamp在Http安全协议中的作用

    http www byywee com page M0 S591 591082 html 写道 前段时间给客户网站做新浪微博账号登录功能 xff0c 对 OAuth协议以及相关的一些安全协议做了一些研究 xff0c 顺便就记录一下学习心得吧
  • NVIDIA TensorRT使用记录

    1 准备工作 1 Pipeline train 在Host PC的GPU上训练test deployment 在TX1 TX2上部署使用 2 主机部署步骤 Running JetPack on the Host JetPack L4T 3
  • 用C语言实现串口通讯程序

    1 首先安装虚拟串口vspd软件 xff0c 用于创建虚拟串口进行互联调试 2 打开vspd软件 xff0c 选择COM1和COM4 xff0c 点击Add pair xff0c 把COM1和COM4互联 3 打开虚拟串口助手 xff0c
  • A2M7雷达在虚拟机的SLAM建图

    准备 Ubuntu18 04 雷达A2M7 一 前期准备 安装 建立工作空间并编译 mkdir p turtlebot ws src cd turtlebot ws src git clone https github com ncnynl
  • linux cmake分别指定编译/运行时动态库链接路径

    1 背景 在树莓派上开发执行程序 xff0c 需要用到opencv curl jsoncpp等库函数支持 xff0c apt get安装好后 xff0c 编译执行正常 但是执行程序挪到别的板子上 xff0c 都要apt get安装这些库 x
  • C语言函数库之字符串连接函数(string.h)

    1 字符串连接函数strcat 函数定义 xff1a char strcat char str1 const char str2 函数功能 xff1a 把str2 包括 39 0 39 拷贝到str1的尾部 连接 xff0c 并返回str1
  • foc学习笔记3——电流环

    foc学习笔记3 电流环 电流环的作用 前文不断强调 xff0c 进行磁场定向控制需要控制的是电流而非电压 xff0c 只是因为我们没有办法直接去控制电流才暂时退而求其次地去控制电压 虽然电压控制的效果也还不错 xff0c 但由于电机不是单
  • ESP32之蓝牙配网blufi

    概览 BluFi 是一款基于蓝牙通道的 Wi Fi 网络配置功能 xff0c 适用于 ESP32 它通过安全协议将 Wi Fi 配置和证书传输到 ESP32 xff0c 然后 ESP32 可基于这些信息连接到 AP 或建立 SoftAP B
  • 机器人学习之项目- Project2 :Where Am I?

    1 项目概述 欢迎来到 Where Am I 我在哪里 定位项目 在这个项目中 xff0c 将学习如何利用ROS AMCL包在Gazebo模拟环境的地图中准确地定位移动机器人 在完成本项目的过程中 xff0c 涉及机器人软件工程的几个方面
  • 将不同类对象指针存放QVector中

    需求 xff1a 将一系列操作步骤放在链表中按需调用 我将每个操作步骤用一个类实现 xff0c 将各类继承于一个基类 xff0c 再将指向各子类的基类指针放在QVector Vector xff0c 即可通过C 43 43 的多态实现调用各
  • 体感摄像头 realsense 系列硬件资料

    一 体感摄像头 Intel的体感摄像机是具有深度图像采集能力的摄像机 xff0c 目前已经出到了400系列 与kinect 2 xff0c ZED xff0c leap motion比较 xff0c 属于比较中庸 手势识别方面不如leap
  • C语言进度条的实现

    C语言进度条的实现 buff N xff1a 进度条状态字符串 xff0c N大小决定进度条长度 xff08 自行调整 xff09 xff0c 使用前先将所有字符初始化置零 xff0c 我这里使用的是memset函数 xff1b label
  • numpy下的随机数

    版权声明 xff1a 本文为博主原创文章 xff0c 未经博主允许不得转载 https blog csdn net m0 38061927 article details 75335069 在使用Python进行数据处理时 xff0c 往往
  • 宏函数 可变参数 C/C++

    span class token macro property span class token directive hash span span class token directive keyword include span spa
  • 排查ingress 404报错的方法--附:在容器中使用tcpdump抓包

    出现这个问题 xff0c 一般是由于路由不通导致的 xff0c 需要进行抓包排查 首先要解决的问题是 xff0c 如何在 ingress controller 容器中安装抓包工具 1 由于 ingress controller 的mando
  • fastApi介绍与重要版本更新细节

    fastApi介绍 FastAPI 是用于使用 Python 构建 API 的现代 Web 框架 它建立在 Starlette 框架之上 xff0c Starlette 框架是一个轻量级且可扩展的 ASGI xff08 异步服务器网关接口
  • 3. fastApi查询参数详解

    当声明的参数不是路径参数时 xff0c 路径操作函数会把该参数自动解释为查询参数 如下 路径操作函数将参数skip limit解释为查询参数 query parameter span class token decorator annota