刚刚为我们的企业应用程序完成了 REST API 的第一个版本,并准备发布下一个版本。我有兴趣了解使用子域对 API 进行版本控制的好处/漏洞。
让我们假设这个结构:
源文件夹:
/var/www/html/domain/api/ (A)
这是目前唯一的版本。比方说,两周后,我们将发布 API 的第二版。将文件从上述文件夹复制到 v1.0。所以新版本的文件夹将是;
源文件夹:
/var/www/html/domain/apiv1-0/ (B)
文件夹 B
将保持不变。所有新开发都将被推送到“A”中的主文件夹。
为了处理指向正确文件夹的问题,在 .htaccess
文件中,我们这样写:
- Check the subdomain
- Match it with the folder
- Server files from that folder.
例子:
api.domain.com ==> Always serves the latest version.
apiv1-0.domain.com ==> Version 1 API will be served.
apiv2-0.domain.com ==> Version 2 API will be served.
我想知道这是否是一个好的做法。有什么注意事项吗? 和 如何设置“.htaccess”来处理上述问题?
我不想在 URI 中使用版本号。这可能是一种标准做法,但我不喜欢它。
编辑:
如您所见,虽然它的子域不同,但每次发布新版本时,我都不必担心 Apache
配置甚至 .htaccess
配置。
编辑: 基本文件夹:
/var/www/html/domain/
最佳答案
I want to know if this is a good practice. Any caveats?
如果您指的是一种版本控制和部署 REST API 的方式,我认为这很好。至于为此使用 htaccess 路由,需要注意的是不同的 API 可能会通过其他域访问,尽管这取决于您的服务器配置而不是规则。例如,如果设置了默认虚拟主机,则某人可能能够通过 http://123.45.67.89/apiv1-0/
访问 api 文件夹。
How to setup '.htaccess' to take care of the above?
你想要这个:
RewriteEngine On
# ensure trailing slashes for /api otherwise mod_dir will expose the underlying layout
RewriteCond %{HTTP_HOST} ^(www\.)?domain.com$ [NC]
RewriteCond %{DOCUMENT_ROOT}/api%{REQUEST_URI} -d
RewriteRule ^(.*[^/])$ /$1/ [L,R=301]
# for /api
RewriteCond %{HTTP_HOST} ^(www\.)?domain.com$ [NC]
RewriteCond %{DOCUMENT_ROOT}/api%{REQUEST_URI} -f [OR]
RewriteCond %{DOCUMENT_ROOT}/api%{REQUEST_URI} -d
RewriteRule ^(.*)$ /api/$1 [L]
# ensure trailing slashes for /apivXXX otherwise mod_dir will expose the underlying layout
RewriteCond %{HTTP_HOST} !^www\. [NC]
RewriteCond %{HTTP_HOST} ^(.+)\.domain.com$ [NC]
RewriteCond %{DOCUMENT_ROOT}/%1%{REQUEST_URI} -d
RewriteRule ^(.*[^/])$ /$1/ [L,R=301]
# for everything else
RewriteCond %{HTTP_HOST} !^www\. [NC]
RewriteCond %{HTTP_HOST} ^(.+)\.domain.com$ [NC]
RewriteCond %{DOCUMENT_ROOT}/%1%{REQUEST_URI} -f [OR]
RewriteCond %{DOCUMENT_ROOT}/%1%{REQUEST_URI} -d
RewriteRule ^(.*)$ /%1/$1 [L]
前 2 条规则与后 2 条规则几乎完全相同,但前 2 条规则将 www*(或什么都不映射)映射到 /api/
,而后 2 条规则处理映射到目录的子域(apiv1-0.domain.com 映射到 /apiv1-0/
。
mod_dir 检查是因为当您尝试请求一个目录时,mod_dir 的 DirectorySlash
将在缺少结尾斜杠的情况下重定向请求。发生这种情况时,您的布局就会暴露,它将无法工作。例如,如果您在 /api/
下有一个目录 test
,并且您请求 http://domain.com/test
,它将重写为 /api/test
并且 mod_dir 将看到“test”是一个目录但没有尾部斜杠,因此 mod_dir 将(错误地)将浏览器重定向到 http://domain。 com/api/test/
,带有尾部斜线但暴露了 /api/
。
关于api - 使用子域对 REST API 进行版本控制,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12167877/