构建现代API:FastAPI中Query与Body参数的最佳搭配

在FastAPI中,QueryBody 是两种不同的依赖注入器,它们的应用场景取决于你的具体需求。以下是它们各自常见的使用场景:

Query 参数

使用场景:

  • 当你需要从URL中获取一些简单的参数时,例如过滤、排序、分页等。 当数据量不大,且可以作为URL的一部分安全传输时。
  • 当数据不需要复杂的结构时。

Body 参数

使用场景:

  • 当你需要发送较为复杂的数据结构时,例如包含多个字段的对象。
  • 当数据量较大,不适合作为URL的一部分时。
  • 当数据需要严格的验证和格式化时。

说明一下二者的区别

Query

Query 用于处理URL查询参数。查询参数是在URL中以键值对形式出现的部分,通常位于URL的问号之后。例如,在URL http://example.com/items?item_id=1&name=Example 中,item_idname 就是查询参数。

你可以使用Query来指定一个路径操作函数的参数应该从查询字符串中获取,并且可以添加额外的验证条件,例如最大长度、最小长度等。

示例:

from fastapi import FastAPI, Queryapp = FastAPI()@app.get("/items/")
async def read_items(item_id: int = Query(..., gt=0), name: str = Query(None, max_length=50)):return {"item_id": item_id, "name": name}# 测试用的客户端请求
# GET /items/?item_id=5&name=Example

在这个例子中,item_id 必须是一个大于0的整数,而name 是一个可选参数,如果有提供的话,它的长度不能超过50个字符。

Body

Body 用于处理请求体中的数据。请求体通常用于发送较大量的数据,特别是当数据结构复杂时,例如JSON对象Body 使得你可以从请求体中提取特定的数据,并且可以添加验证条件,如gt(大于)、ge(大于等于)等。

示例:

from fastapi import FastAPI, Bodyapp = FastAPI()@app.post("/items/")
async def create_item(item_id: int = Body(..., gt=2)):return {"item_id": item_id}# 测试用的客户端请求
# POST /items/
# Content-Type: application/json
#
# {
#     "item_id": 5
# }

在这个例子中,item_id 必须是一个大于2的整数,并且它从请求体中的JSON数据中提取出来。

总结

  • Query: 用于处理URL查询参数,即URL中?后面的部分。
  • Body: 用于处理请求体中的数据,通常用于处理POST、PUT等请求中的JSON数据。

两者的主要区别在于它们从哪里获取数据:Query 从URL查询字符串中获取数据,而Body 从请求体中获取数据。此外,它们可以有不同的验证条件,但这些条件的使用方式是相似的。你可以使用相同的验证器,如gtgemin_lengthmax_length等,来确保数据符合预期的要求。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/web/52222.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

李宏毅机器学习笔记——反向传播算法

反向传播算法 反向传播(Backpropagation)是一种用于训练人工神经网络的算法,它通过计算损失函数相对于网络中每个参数的梯度来更新这些参数,从而最小化损失函数。反向传播是深度学习中最重要的算法之一,通常与梯度下降…

java上一页下一页的代码怎么写

在Java中实现“上一页”和“下一页”功能的代码,通常用于分页的情况,比如从数据库查询数据并分页显示结果。假设你有一个列表,想要通过“上一页”和“下一页”按钮来翻页,可以使用以下代码作为参考。 假设我们有一个数据列表&…

软考基础知识之计算机网络

目录 前言 网络架构与协议 网络互联模型 1、OSI/RM 各层的功能 2、TCP/IP 结构模型 常见的网络协议 1、应用层协议 2、传输层协议 3、网络层协议 IPv6 前言 从古代的驿站、 八百里快马, 到近代的电报、 电话, 人类对于通信的追求从未间断&…

Docker 镜像配置

在 Docker 的使用过程中,拉取镜像是一个常见的操作,但在国内由于网络问题,直接从 Docker Hub 拉取镜像可能会比较慢。为了解决这个问题,我们可以配置 Docker 使用国内镜像源,从而加速镜像的拉取过程。本文将介绍如何配…

心觉:你为什么没有更多的钱

很多人希望自己可以赚更多的钱 但是他的内心又很讨厌钱,他自己并不知道 一边希望自己赚更多钱,一边在骨子里觉得“金钱是万恶之源” 这是一种神经质的错乱 这种现象在什么情况下会表现得比较明显呢? 某位高官因为贪污受贿落马了&#xf…

风控系统之指标回溯,历史数据重跑

个人博客:无奈何杨(wnhyang) 个人语雀:wnhyang 共享语雀:在线知识共享 Github:wnhyang - Overview 回顾 默认你已经看过之前那篇风控系统指标计算/特征提取分析与实现01,Redis、Zset、模版方…

前端基础面试题·第三篇——JavaScript(其一)

1.JavaScript数据类型与运算符 数据类型 原始数据类型: 1.Number 2.String 3.Boolean 4.undefined 5.null 6.Symbol 7.bigint 复杂数据类型: 1.Function 2.非函数: Array: 数组 Object: 对象 Date: 日期 RegExp: 正则 Map: 映射 Set: 集合 …

word中怎么快速选中光标之前或之后的全部内容?

在Word中,快速选中光标之后的全部内容的快捷键:Ctrl Shift End; 在Word中,快速选中光标之前的全部内容的快捷键:Ctrl Shift Home。 在Word中,选取的快捷键如下。 一、选定整个文本: 1&#…

Cozer必备!一站式解锁扣子全网最全插件集锦(五)

俗话说,工欲善其事必先利其器! 用过Coze的朋友都知道,插件在Coze里的重要性。插件库就相当于武器库,一个好的插件,就相当于一件趁手的兵器,可以让你事半功倍! 程哥精心整理了Coze最常用和好用…

spring cloud openFeign

1:Intellij 新建 项目 order-service 2:pom.xml <?xml version"1.0" encoding"UTF-8"?> <project xmlns"http://maven.apache.org/POM/4.0.0"xmlns:xsi"http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation&q…

golang学习笔记02——gin框架及基本原理

目录 1.前言2.必要的知识3.路由注册流程3.1 核心数据结构3.2 执行流程3.3 创建并初始化gin.Engine3.4 注册middleware3.5 注册路由及处理函数&#xff08;1&#xff09;拼接完整的路径参数&#xff08;2&#xff09;组合处理函数链&#xff08;3&#xff09;注册完成路径及处理…

精通Java微服务

第1章 微服务是在面向服务架构SOA的基础上进一步发展而来的&#xff0c;它比SOA做得更加彻底&#xff0c;其单体服务被更加彻底地划分&#xff0c;最大限度地实现了服务的单一职责。 1.1.2互联网 即计算机网络&#xff0c;连接了世界上数以万计的计算机设备&#xff08;可联…

15、Django Admin添加自定义字段功能

修改模型类HeroAdmin admin.register(Hero) class HeroAdmin(admin.ModelAdmin):change_list_template "entities/heroes_changelist.html"... # 此处原代码不动&#xff0c;只增加此前后代码def get_urls(self):urls super().get_urls()my_urls [path(immort…

最新版 | SpringBoot3如何自定义starter(面试常考)

文章目录 一、自定义starter介绍二、自定义Starter的好处及优势三、自定义starter应用场景四、自定义starter1、创建autoconfigure的maven工程2、创建starter的maven工程3、在autoconfigure的pom文件中引入MyBatis的所需依赖4、编写自动配置类MyBatisAutoConfiguration5、编写i…

pdf文件编辑器有哪些?分享适合新手用的5个PDF编辑器(解锁教程)

pdf是一种通用文件格式&#xff0c;也是一种夸操作系统平台的文件格式。 好用的PDF文件编辑器可以让您更改和添加文本、编辑图像、添加图形、签署签名、填写表单数据等。下面整理了关于pdf文件编辑方法介绍&#xff0c;以及一些好用的pdf编辑器&#xff0c;有需要的可以了解下…

JavaScript初级——Navigatior

1、Navigator 代表当前浏览器的信息&#xff0c;通过该对象可以来识别不同的浏览器。 2、由于历史原因&#xff0c;Navigator 对象中的大部分属性已经不能帮助我们是被浏览器了。 3、一般使用 userAgent 来判断浏览器的信息。 4、 userAgent 是一个字符串&#xff0c;包含有用来…

C# 通过拖控件移动窗体

目录 引言一、通过控件事件移动窗体1、创建窗体界面2、添加控件事件3、添加代码 二、通过windowsAPI移动窗体1、 构建窗体和添加事件2、代码展示 引言 在C#Form窗体设计中&#xff0c;如果我们不需要使用默认边框设计自己个性化的窗体&#xff08;FromBorderStylenone时&#…

LEAN 类型理论之注解(Annotations of LEAN Type Theory)-- 商类型(Quotient Type)

商类型&#xff08;Quotient Type&#xff09;&#xff0c;也称划分类型&#xff0c;通过给定义一个定义在某一类型 α 上的关系R&#xff1a;α → α→ ℙ&#xff0c;将类型α 中&#xff0c;满足关系R的元素摘出来&#xff0c;组成该商类型&#xff08;Quotient&#xff09…

2024国赛数学建模C题完整论文:农作物的种植策略

农作物种植策略优化的数学建模研究&#xff08;完整论文&#xff0c;持续更新&#xff0c;大家持续关注&#xff0c;更新见文末名片 &#xff09; 摘要 在本文中&#xff0c;建立了基于整数规划、动态规划、马尔科夫决策过程、不确定性建模、多目标优化、相关性分析、蒙特卡洛…

20:HAL--RNG

一&#xff1a;RNG 伪随机数就是rand函数产生的数。 F1系列的没有RNG,使用本次说的都是F407的&#xff0c;我使用的是STM32F407VET6 B&#xff1a;框架 C&#xff1a;寄存器 /*RNG_SR寄存器的DRDY位*/ while ((__HAL_RNG_GET_FLAG(&rng_handle, RNG_FLAG_DRDY) RESET) …