nginx 实现接口版本控制
背景
近期项目做了不兼容的升级,项目上线时需要考虑两个版本的兼容。由于项目代码并未考虑接口版本控制,因此需要部署一套新版本的系统,并使用 nginx 对两个版本的接口进行分发。
实现思路
考虑了两种实现实现方式:
配置新的子域名,用于标识版本号,如:v2.api.xxx.com,新版本使用该域名进行调用
在原来接口前面添加版本前缀进行标识,如:api.xxx.com/v2/users
考虑项目情况,最终决定使用第二种方式,因为如果使用第一种方式会存在如下问题:
一些服务需要重新配置域名白名单,如微信小程序需要重新添加业务域名等
目前项目 tls 没有配置为泛域名,因此如果使用新的域名还需要配置 tls
实现
项目服务使用 php 实现,并使用了 laravel 框架,如果是其他技术实现,需要做相应的修改。
实现步骤:
启动新的 php-fpm 服务,使用新的端口号 9001,旧版本 php 监听了 9000 端口
修改 nginx 配置文件如下,为了看起来清晰,这里省略了不相关的配置
注意事项
nginx 中 root 配置一定要放到 location 下,因为两个版本使用的代码不在一个目录
因为项目中并不存在 /v2 目录,因此通过 fastcgi 转发到 php 的时候(SCRIPT_FILENAME 参数),要捕获去掉 /v2 前缀的路径部分,而不再使用 $fastcgi_script_name 变量
版权声明: 本文为 InfoQ 作者【lockdown56】的原创文章。
原文链接:【http://xie.infoq.cn/article/38979ef4d44321f54f719b2ad】。文章转载请联系作者。
评论