讲师中心 微信公众号
AI工具推荐 视频效率加速

如何通过 location 块 的 rewrite 规则实现 Restful API 的参数重构

陌敏吖_1473

陌敏吖_1473

发布时间:2026-05-21 21:03:46

|

779人浏览过

|

来源于php中文网

原创

Nginx中location配合rewrite可实现Restful API路径参数重构,优先用proxy_pass末尾/截断路径透传,必要时用正则捕获+rewrite转换为查询参数,避免滥用if和嵌套规则。

如何通过 location 块 的 rewrite 规则实现 restful api 的参数重构

在 Nginx 中,通过 location 块配合 rewrite 指令,可以将客户端请求的 URL 路径“重写”为后端服务能识别的格式,从而实现 Restful API 的参数重构(例如把 /api/users/123 映射为 /api/user?id=123),或更常见的——将带路径参数的风格转为标准代理路径(如保留 /api/users/123 但透传给后端处理)。关键在于理解 rewrite 的执行时机、正则捕获、flag 作用及与 proxy_pass 的协同。

明确 rewrite 的作用范围和触发条件

rewrite 在 location 块内生效,仅对匹配该 location 的请求起作用。它不改变客户端看到的 URL(除非加 redirect 或 permanent),而是内部重写请求 URI,供后续指令(如 proxy_pass)使用。

  • rewrite 在 location 匹配后、进入子请求前执行,可多次执行(受 last/break 控制)
  • 必须用正则表达式(~ 或 ~*)定义的 location 才能可靠捕获路径参数;前缀匹配(location /api/)无法直接提取变量
  • 捕获组用 $1、$2 等引用,命名捕获(?<name></name>)需 Nginx ≥ 1.11.0 且启用 PCRE2

常见 Restful 路径参数重构方式

假设后端服务只接受查询参数形式(/user?id=123&type=admin),而前端调用的是 Restful 风格(/api/v1/users/123),可用 rewrite 提取并重组:

location ~ ^/api/v1/users/(\d+)$ {
    rewrite ^/api/v1/users/(\d+)$ /user?id=$1? break;
    proxy_pass http://backend;
}

说明:

  • ~ 启用大小写敏感正则匹配
  • (\d+) 捕获用户 ID,$1 引用它
  • 末尾 ? 清空原始 query string,避免重复拼接
  • break 终止当前 location 内 rewrite,直接走 proxy_pass

保持路径结构、仅透传给后端(推荐做法)

现代 Restful API 后端(如 Express、Spring Boot)通常直接解析路径参数。此时无需重写为 query,只需确保路径正确转发:

location /api/ {
    proxy_pass http://backend/;
}

注意:proxy_pass 末尾的 / 会剥离 /api/ 前缀,使 /api/v1/users/123 实际发往 http://backend/v1/users/123。这是最简洁、语义最清晰的方式,避免 rewrite 带来的隐式转换风险。

  • 若不用末尾 /,如 proxy_pass http://backend;,则整个原始 URI(含 /api/...)会被完整转发
  • 需要改写路径但又不想用 rewrite?可用 proxy_rewrite(需 ngx_http_sub_module)或更灵活的 map + rewrite 组合

高级:多级资源嵌套与可选参数处理

例如支持 /api/posts/42/comments 和 /api/posts/42/comments/17:

location ~ ^/api/posts/(\d+)/comments(?:/(\d+))?$ {
    if ($2) {
        rewrite ^/api/posts/\d+/comments/\d+$ /comment?id=$2? break;
    }
    if ($1) {
        rewrite ^/api/posts/\d+/comments$ /comments?post_id=$1? break;
    }
}

但注意:if 在 location 中有局限,更健壮的做法是用两个独立 location 分流:

location ~ ^/api/posts/(\d+)/comments/(\d+)$ {
    rewrite ^/api/posts/\d+/comments/\d+$ /comment?id=$2? break;
    proxy_pass http://backend;
}
location ~ ^/api/posts/(\d+)/comments$ {
    rewrite ^/api/posts/\d+/comments$ /comments?post_id=$1? break;
    proxy_pass http://backend;
}

Restful 参数重构本质是请求路径到后端接口约定的映射。优先采用 proxy_pass 路径截断,其次用 rewrite 做必要转换;避免过度依赖 if 和嵌套 rewrite,保持规则可读与可维护。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3069

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2288

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1220

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1158

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1336

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2118

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3380

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

15195

2023.09.22

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn