0

0

fastapi 如何让路径参数同时支持正则表达式限制

冰川箭仙

冰川箭仙

发布时间:2026-01-23 20:36:02

|

255人浏览过

|

来源于php中文网

原创

FastAPI路径参数正则约束必须写在路由字符串的{param:regex}中,而非Path()的regex参数;例如"/items/{item_id:\d{3,6}}"有效,而Path(..., regex=r"\d{3,6}")对路径参数无效。

fastapi 如何让路径参数同时支持正则表达式限制

FastAPI 路径参数怎么加正则约束

FastAPI 原生支持在路径参数中嵌入正则表达式,不需要额外写验证逻辑或中间件。关键是在 {param_name:regex} 语法里直接写正则,而不是靠 Path(..., regex=...) —— 后者只对查询参数或请求体字段有效,对路径参数无效。

路径参数正则必须写在路由字符串里

这是最容易踩的坑:Pathregex 参数对路径参数完全不起作用。FastAPI 解析路径时,只认 URL 模板里的内联正则。比如想限制 item_id 只能是 3~6 位数字:

@app.get("/items/{item_id:\d{3,6}}")
def read_item(item_id: str):
    return {"item_id": item_id}

注意:\d{3,6} 是写在 {item_id:...} 冒号后面的部分,不是传给 Path() 的参数。如果写成这样就无效:

@app.get("/items/{item_id}")
def read_item(item_id: str = Path(..., regex=r"\d{3,6}")):  # ❌ 不会校验路径匹配

正则里要小心转义和特殊字符

URL 路径中斜杠 /、点 .、括号等有特殊含义,写正则时得双重转义(Python 字符串 + FastAPI 路由解析):

Kive
Kive

一站式AI图像生成和管理平台

下载
  • 匹配带下划线的用户名:{username:[a-zA-Z0-9_]+},不用双反斜杠
  • 匹配含点的域名片段(如 api.example.com):{domain:[a-zA-Z0-9.-]+},点在字符组里不需转义
  • 想匹配字面量 {}?不行 —— 这些是 FastAPI 路由语法定界符,无法出现在正则中
  • 避免用 .* 开头,否则可能吞掉后续路径段,比如 {path:.+}/detail 会破坏路由结构

多个路径参数正则可以共存,但顺序和贪婪性要留意

多个带正则的参数可以一起用,FastAPI 会按顺序尝试匹配。例如:

@app.get("/files/{year:\d{4}}/{month:\d{2}}/{name:[a-z]+\.txt}")
def get_file(year: int, month: int, name: str):
    ...

这里要注意:

  • yearmonth 的正则必须严格匹配长度,否则可能被后一个参数“抢走”字符
  • 如果 name 正则太宽泛(比如用 .*),month 就可能匹配失败,因为路径分割依赖正则边界
  • 所有路径参数正则最终都编译为 Python 的 re.Pattern,所以支持 ^$,但没必要加 —— FastAPI 自动锚定整个路径段

真正难调的不是写法,而是当正则和实际 URL 边界不一致时,FastAPI 直接返回 404,连错误提示都不告诉你哪段正则没命中。

相关专题

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

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

772

2023.06.15

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

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

661

2023.07.20

python能做什么
python能做什么

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

765

2023.07.25

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

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

679

2023.07.31

python教程
python教程

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

1385

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相关的文章、下载、课程内容,供大家免费下载体验。

730

2023.08.11

yy漫画官方登录入口地址合集
yy漫画官方登录入口地址合集

本专题整合了yy漫画入口相关合集,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共4课时 | 15.3万人学习

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号