【Python系列】FastAPI 中的路径参数和非路径参数解析问题

💝💝💝欢迎来到我的博客,很高兴能够在这里和您见面!希望您在这里可以感受到一份轻松愉快的氛围,不仅可以获得有趣的内容和知识,也可以畅所欲言、分享您的想法和见解。
img

  • 推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老
  • 导航
    • 檀越剑指大厂系列:全面总结 java 核心技术,jvm,并发编程 redis,kafka,Spring,微服务等
    • 常用开发工具系列:常用的开发工具,IDEA,Mac,Alfred,Git,typora 等
    • 数据库系列:详细总结了常用数据库 mysql 技术点,以及工作中遇到的 mysql 问题等
    • 新空间代码工作室:提供各种软件服务,承接各种毕业设计,毕业论文等
    • 懒人运维系列:总结好用的命令,解放双手不香吗?能用一个命令完成绝不用两个操作
    • 数据结构与算法系列:总结数据结构和算法,不同类型针对性训练,提升编程思维,剑指大厂

非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨

博客目录

    • 1.问题描述
    • 2.问题分析
    • 3.解决方案
    • 4.最佳实践
    • 5.结论

在 FastAPI 框架中,路由的配置是构建 RESTful API 的关键步骤。路由配置不仅需要正确地定义路径参数,还需要正确地处理非路径参数,以确保 API 的访问逻辑清晰且正确。然而,当路径参数和非路径参数的前缀一致时,可能会出现一些混淆,导致非预期的路由行为。本文将通过分析给出的代码示例,探讨这一问题,并提供相应的解决方案。
在这里插入图片描述

1.问题描述

在提供的代码示例中,我们可以看到两个路由装饰器@KBRouter.post被应用于两个不同的函数。第一个函数get接收一个路径参数id,而第二个函数get则没有路径参数,但接收一个非路径参数info。两个函数的路由路径前缀都是/collection/docs,这可能导致一些混淆。

FastAPI 路径参数和非路径参数的前缀一致,当访问非路径参数的接口时,会走到路径参数的接口中

@staticmethod
@KBRouter.post("/collection/docs/{id}", description="路径参数接口",summary="路径参数接口")
async def get(id: str = None):return {"code": 0,"data": None,"msg": "成功"}
@staticmethod
@KBRouter.post("/collection/docs/add", description="非路径参数接口",summary="非路径参数接口")
async def get(info: str = None):return {"code": 0,"data": None,"msg": "成功",}

2.问题分析

FastAPI 使用基于 Python 类型提示的参数来定义路径参数和查询参数。路径参数通过在函数参数中使用Path来声明,而非路径参数则直接作为函数参数声明。在上述代码中,第一个get函数使用Path来声明路径参数id,而第二个get函数则直接声明了非路径参数info

问题出现在两个函数的路由路径前缀相同,但一个是路径参数,另一个是非路径参数。当客户端发送请求到/collection/docs/add时,FastAPI 可能会错误地将请求路由到第一个get函数,因为add可以被解释为id的值。

3.解决方案

为了解决这个问题,我们需要确保路径参数和非路径参数的路由清晰区分。以下是几种可能的解决方案:

  1. 更改非路径参数的路由前缀:最简单的方法是更改第二个get函数的路由前缀,以避免与路径参数的前缀冲突。例如,可以将/collection/docs/add更改为/collection/docs/non_path

  2. 使用不同的 HTTP 方法:如果逻辑允许,可以考虑为两个接口使用不同的 HTTP 方法,比如 GET 和 POST,这样可以在不改变路由前缀的情况下区分它们。

  3. 明确区分路径参数和非路径参数:在设计 API 时,应该明确区分路径参数和非路径参数的使用场景,避免在同一个前缀下同时使用它们。

  4. 使用请求体来传递非路径参数:如果非路径参数的数据量较大或者需要更复杂的数据结构,可以考虑使用请求体(如 JSON)来传递这些参数,而不是通过查询参数。

  5. 增加 API 文档和版本控制:通过增加详细的 API 文档和版本控制,可以帮助开发者和用户更好地理解 API 的使用方法,减少因路由混淆导致的错误。

4.最佳实践

在设计和实现 FastAPI 应用时,应该遵循以下最佳实践:

  • 清晰的路由设计:确保每个路由都有清晰、明确的含义,避免使用容易引起混淆的参数名或前缀。

  • 合理的参数使用:合理使用路径参数和非路径参数,确保它们的使用场景和目的清晰。

  • 充分的测试:在部署 API 之前,进行充分的测试,包括单元测试和集成测试,确保 API 的行为符合预期。

  • 错误处理:实现错误处理逻辑,当请求不符合预期时,能够返回清晰的错误信息。

  • 遵循 RESTful 原则:设计 API 时,遵循 RESTful 原则,使用合适的 HTTP 方法和状态码来表达操作和结果。
    在这里插入图片描述

5.结论

FastAPI 是一个强大而灵活的框架,但在设计 API 时,需要特别注意路径参数和非路径参数的区分,以避免路由混淆的问题。通过上述的解决方案和最佳实践,可以确保 API 的清晰性和可用性,为用户提供更好的服务。

觉得有用的话点个赞 👍🏻 呗。
❤️❤️❤️本人水平有限,如有纰漏,欢迎各位大佬评论批评指正!😄😄😄

💘💘💘如果觉得这篇文对你有帮助的话,也请给个点赞、收藏下吧,非常感谢!👍 👍 👍

🔥🔥🔥Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧!🌙🌙🌙

img

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

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

相关文章

dockercompose部署redis哨兵模式并集成springboot

第一步 编写compose文件 docker-compose.yml version: 3.8networks:redis-network:driver: bridgeservices:redis-master:image: redis:7.2.4container_name: redis-mastercommand: ["sh", "-c", "redis-server --protected-mode no --slave-announ…

产品经理基础入门

一、产品基础(需求收集、需求管理、需求分析、结构图、流程图、原型、PRD文档、用户画像、后台的角色管理) 产品经理定义: 1.市场分析:找准市场方向,确定哪个市场是值得进入的。 2.用户分析:针对目标市场…

python项目加密和增加时间许可证

1.bat,执行如下的命令,第一句是更新或增加许可证 第二句是加密draw_face.py python offer.py pyarmor obfuscate -O dist draw_face.py绘制自制人脸.py,调用加密的代码draw_face代码 import sys import os import cv2# 添加加密模块所在的路…

爬虫笔记16——异步爬取二手汽车数据去重存入MySQL

需要用到的库 #异步数据库 pip install aiomysql #reids数据库进行去重 pip install redis #用hashlib进行md5加密 pip install hashlib #基于异步IO的网络请求库 pip install aiohttp #xpath获取静态页面数据 pip install lxml目标网站 目标网站:https://www.che…

高考专业组 07组 08组 武汉大学

武汉大学的招生都什么废物点心,搜个专业组都没官方解释! 07组:理学,详见下表专业代码07xxxx,例如数学、物理、化学 08组:工学,详见下表专业代码08xxxx,例如机械、电子信息、自动化、…

每天一个数据分析题(三百七十八)- 系统聚类

在系统聚类方法中,哪种系统聚类是直接利用了组内的离差平方和? A. 最长距离法 B. 重心法 C. Ward法 D. 类平均法 数据分析认证考试介绍:点击进入 题目来源于CDA模拟题库 点击此处获取答案 数据分析专项练习题库 内容涵盖Python&#…

R语言做图

目录 1. 图形参数 2. 低级图形 3. 部分高级图形 参考 1. 图形参数 图形参数用于设置图形中各种属性。 有些参数直接用在绘图函数内,如plot函数可以用 pch(点样式)、col(颜色)、cex(文字符号大小倍数&…

ONLYOFFICE 桌面编辑器 8.1

ONLYOFFICE 简介 ONLYOFFICE 是一个开源的办公套件,它提供了在线文档编辑器、表格编辑器和演示文稿编辑器,这些编辑器能够兼容 Microsoft Office 格式(.docx, .xlsx, .pptx)以及其他流行的标准格式。ONLYOFFICE 的核心功能包括多…

Spcok测试代码抛异常场景

测试代码抛异常场景 ‍ class ExceptionSpec extends Specification {def validateService new ValidateService()Unrolldef "验证UserInfo"() {when: "调用校验方法"validateService.validateUser(user)then: "捕获异常并设置需要验证的异常值&qu…

注意力机制的原理

注意力机制的原理 注意力机制是深度学习中的一种关键组件,尤其是在处理序列数据,如自然语言处理任务时,它允许模型关注输入序列的不同部分,而不是对所有元素赋予相同的权重。其基本思想是为每个输入位置赋予一个权重,…

分类预测 | ZOA-PCNN-AT-SVM斑马优化并行卷积-支持向量机融合注意力机制的故障识别

分类预测 | ZOA-PCNN-AT-SVM斑马优化并行卷积-支持向量机融合注意力机制的故障识别 目录 分类预测 | ZOA-PCNN-AT-SVM斑马优化并行卷积-支持向量机融合注意力机制的故障识别分类效果基本描述程序设计参考资料 分类效果 基本描述 1.ZOA-PCNN-AT-SVM斑马优化并行卷积-支持向量机融…

《2024天猫618大促-首波男装销售报告》

这份报告主要分析了2024年天猫618大促期间的首波男装销售情况,从多个维度进行了深入的复盘和分析。报告中不仅包含了销售数据的统计分析,还对消费者行为、品牌表现、产品趋势等方面进行了详细的解读。通过对这些数据和信息的深入挖掘,报告揭示了当前男装市场的一些重要趋势和特…

qt经典界面框架

目的 其实就是一个简单的界面显示,是很常用的形式。 说起来简单也是简单,但当初,刚开始做时,感觉非常的复杂,不知如何下手。 现在感觉简单多了。 这个框架利用了QT的现成的MainWindow与QDockWidget,这样就…

Vue3 + TS 防抖动

目录 一、防抖动 1、概念 2、原理 3、应用场景 1、概念 通过将多次连续触发的函数调用合并成一次来减少函数的执行次数。防抖的核心思想是在某个时间段内,只执行一次函数,而忽略在此时间段内的其他触发。 2、原理 (1)、定时器; (2)、重…

java基于ssm+jsp 人才公寓管理系统

1管理员功能模块 管理员登录,通过填写用户名、密码进行登录,如图1所示。 图1管理员登录界面图 管理员登录进入人才公寓管理系统可以查看个人中心、住户管理、小区公告管理、停车位管理、安保人员管理、安保值班管理、房屋信息管理、外来登记管理、物品…

把STL容器放入共享内存,重用STL allocator,传入模板参数Allocator,可以实现

问题 Q: 如何用共享内存来存放C STL中中的容器? A: 传入自定义的申请共享内存上空间的allocator,见模板参数Allocator 参考 https://www.zhihu.com/question/319108981/answer/649050789 https://en.cppreference.com/w/cpp/container/vector http://…

自定义User-Agent:使用Python Requests进行网络请求

在网络编程和数据采集领域,HTTP请求是与服务器交互的基本方式。User-Agent(用户代理)是HTTP请求中的一个重要字段,它告诉服务器发起请求的客户端类型和版本信息。在某些情况下,自定义User-Agent可以帮助我们模拟不同的…

CodeIgniter学习笔记 Item6--CI中的常规主题_ci中parent __construct();

$route[default\_controller] welcome; $route[404\_override] ;更重要的功能是,如果我们要实现通过/index.php/news/4.html访问/index.php/article/show/1这样一个需求,可以在routes.php定义路由关系,将原始的URL转换成需要样式 $route[n…

QtSingleApplication

​​​​​​/qtsingleapplication/ qtSingleApplication使用总结-CSDN博客 示例&#xff1a; #include "mainwindow.h" #include <QApplication> #include <QMessageBox> #include "qtsingleapplication/qtsingleapplication.h" int main(…

正向代理与反向代理:深入解析与实例讲解

代理服务器是一种网络实体&#xff0c;它充当客户端与服务器之间的中介&#xff0c;负责转发请求和响应。代理服务器可以根据其使用方式和功能的不同&#xff0c;分为正向代理和反向代理。 转转的面试中问到了正向代理和反向代理。所以本篇文章将详细解析这两种代理方式&#…