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

Linux Nginx 怎么用 rewrite 实现 API 接口版本号的优雅升级

老萱吖_7909

老萱吖_7909

发布时间:2026-09-27 13:13:03

|

499人浏览过

|

来源于php中文网

原创

Nginx通过rewrite实现API版本优雅升级:前缀匹配重写(如^~ /api/v1/)可静默映射至/api/或/api/v2/,配合last/break控制流程;结合map指令支持按请求头或参数动态路由;务必用$request_uri或正则捕获保留查询参数,并添加兜底健康检查保护。

linux nginx 怎么用 rewrite 实现 api 接口版本号的优雅升级

用 rewrite 实现 API 接口版本号的优雅升级,核心是把带版本号的请求路径(比如 /api/v1/users)在 Nginx 层内部重写为后端实际能处理的新路径(如 /api/v2/users 或 /api/users),客户端无感知、不跳转、不改代码。

按路径前缀重写(最常用、最直观)

适合 URL 已统一规划、旧客户端大量存在、需长期兼容的场景。例如所有 v1 请求走 /api/v1/xxx,但后端新服务只监听 /api/xxx 或 /api/v2/xxx。

  • 将 /api/v1/ 全部映射到新服务根路径:
    location ^~ /api/v1/ {<br>  rewrite ^/api/v1/(.*)$ /api/$1 break;<br>}
  • 若新服务部署在 /api/v2/,想静默升级旧调用:
    location ^~ /api/v1/ {<br>  rewrite ^/api/v1/(.*)$ /api/v2/$1 last;<br>}

    注意:用 last 会重新匹配 location,适合需要进入新 location 块做 proxy_pass 的情况;break 则终止重写,在当前 location 内继续处理。
  • 避免正则误伤:用 ^~ /api/v1/ 而非 ~ /api/v1/,确保前缀匹配优先级高,不被其他正则规则干扰。

用 map + rewrite 实现动态路由(支持灰度与多版本共存)

当需要按请求头、参数或业务标识分流(比如部门 ID=101 走 v2,其余走 v1),仅靠 rewrite 不够,必须结合 map 指令预定义变量。

linux-sysadmin
linux-sysadmin

Linux系统管理专家,覆盖12大模块:用户权限、SSH、存储、网络、systemd、防火墙、日志监控、备份恢复、TLS证书、Ansible、容器、IaC。提供配置、验证、加固、监控、备份、自动化、故障排查、回滚闭环。关键词:useradd、sudo、sshd_config、chmod、SEL...

下载
  • 在 http 块中定义版本映射:
    map $http_x_api_version $backend_path {<br>  default "/v1";<br>  "2" "/v2";<br>  "canary" "/v2";<br>}
  • 在 location 中使用:
    location /api/ {<br>  proxy_pass http://backend$backend_path$request_uri;<br>}

    这样 X-API-Version: 2 的请求自动转发到 http://backend/v2/...,URL 干净,也便于 AB 测试。
  • 也可结合查询参数:
    map $arg_version $backend_path {<br>  default "/v1";<br>  "2" "/v2";<br>}

    让 ?version=2 触发切换,开发调试友好。

重写时保留原始参数与请求头

rewrite 只改 URI 路径,不会自动携带原查询参数。若目标路径需透传参数,要用 $request_uri 或显式拼接。

  • 错误写法(丢参数):
    rewrite ^/api/v1/users$ /api/v2/users;
    → /api/v1/users?id=123 变成 /api/v2/users,参数丢失。
  • 正确写法(保留全部):
    rewrite ^/api/v1/users(.*)$ /api/v2/users$1 break;
    或更稳妥:
    rewrite ^/api/v1/(.*)$ /api/v2/$1 break;
    再配合 proxy_pass 使用 $request_uri,确保完整转发。
  • 如需注入新请求头(如标记版本来源):
    proxy_set_header X-Api-From "v1-rewrite";

上线前必做的三件事

rewrite 规则一旦出错容易导致 404、循环重定向或覆盖健康检查路径,必须验证到位。

  • 语法校验:nginx -t 确保配置无误;
  • 作用域测试:用 curl -v http://host/api/v1/users 看响应头 Location 是否出现(不该有)、后端日志是否收到预期路径;
  • 兜底保护:用 location ^~ /health 或 /metrics 单独配置,防止 rewrite 规则误匹配运维接口。

热门AI工具

更多
豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Atoms
Atoms Hot

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

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

383

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3067

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

5585

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

541

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1456

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3918

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

122

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

417

2026.01.13

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习

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

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