0

0

fastapi 如何让 Path 参数支持正则表达式限制

冷炫風刃

冷炫風刃

发布时间:2026-01-24 15:04:49

|

173人浏览过

|

来源于php中文网

原创

FastAPI中Path参数正则约束需写在路径字符串中,格式为{param_name:regex},如@app.get("/item/{item_id:\d+}");正则在路由匹配阶段生效,不满足则直接404,且不可含捕获组。

fastapi 如何让 path 参数支持正则表达式限制

FastAPI 中 Path 参数如何用正则表达式约束路径段

FastAPI 原生支持在 Path 参数中嵌入正则表达式,但不是靠 Python 的 re 模块手动校验,而是通过路径参数的「类型注解 + 正则语法」直接定义规则。关键在于:正则写在路径字符串里,不是写在函数参数的 regex=... 里。

路径正则必须写在路由装饰器的路径字符串中

错误做法是试图在 Path(...) 里传正则对象或字符串——FastAPI 不识别这种用法。正确方式是把正则写进路径模板,用 {param_name:regex} 格式:

@app.get("/item/{item_id:\d+}")
def read_item(item_id: int):
    return {"item_id": item_id}
  • \d+ 是正则表达式,匹配一个或多个数字;整个 {item_id:\d+} 表示该路径段只接受纯数字
  • 注意:item_id 的类型注解仍需写(如 int),FastAPI 会先按正则匹配路径,再尝试类型转换
  • 如果请求是 /item/abc,直接返回 404(不进函数);如果是 /item/123,才调用函数并转成 int
  • 正则中不能有捕获组 (),否则报错;只支持基本语法,如 [a-z]\w+[0-9]{4}

常见正则写法与对应场景

实际开发中高频用到的几种模式:

SpeechEasy
SpeechEasy

SpeechEasy是一种合成语音解决方案,可以让用户从文本生成高质量、易于理解的音频。

下载
  • 纯字母 ID:/user/{username:[a-zA-Z]+} —— 避免数字开头或混入符号
  • 带分隔符的版本号:/api/v{version:[0-9]\.[0-9]} → 匹配 v1.2,但不匹配 v10.20
  • 十六进制哈希:/file/{sha256:[a-f0-9]{64}} —— 精确 64 位小写 hex
  • 可选前缀的路径:/docs/{section:(?:api|user|admin)?} —— 注意非捕获组 (?:...) 写法,避免括号被误解析

正则不生效?检查这三点

正则没起作用,大概率是以下原因:

  • 路径字符串里漏了冒号,比如写成 {item_id\d+}(缺 :)→ FastAPI 当作普通字符串字面量处理
  • 正则里用了未转义的特殊字符,如点号 . 没写成 \. → 导致匹配行为异常
  • 路径段被其他更宽泛的路由覆盖,例如 /item/{item_id}/item/{item_id:\d+} 同时存在,前者会优先匹配所有输入,后者永远不触发

正则限制发生在路由匹配阶段,早于依赖注入和参数校验,所以它既是安全边界,也是性能开关——写得太松会导致无效请求穿透到后续逻辑。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

773

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

765

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

699

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1405

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 17.1万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号