使用子域来版本化REST API

时间:2012-08-28 21:37:52

标签: api .htaccess versioning

刚刚为我们的企业应用程序完成了第一个REST API版本,然后继续下一个版本。我有兴趣了解使用子域来为API版本的好处/漏洞。

让我们假设这个结构:

源文件夹:

   /var/www/html/domain/api/ (A)

这是目前唯一的版本。可以说,从现在起2周后,我们将发布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/

1 个答案:

答案 0 :(得分:1)

  

我想知道这是不是一个好习惯。有什么警告吗?

如果您的方法是版本化和部署REST API,我认为这很好。至于为此使用htaccess路由,有一些警告可以通过其他域访问不同的API,尽管这将取决于您的服务器配置而不是规则。例如,如果设置了默认vhost,则某人可能能够通过http://123.45.67.89/apiv1-0/访问api文件夹。

  

如何设置'.htaccess'来处理上述问题?

你想要这个:

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个规则非常重复,但第一个规则将 www * (或没有)映射到/api/,第2个规则处理映射到的子域目录( apiv1-0 .domain.com映射到/apiv1-0/

mod_dir检查是因为当您尝试请求目录时,如果缺少尾部斜杠,mod_dir的DirectorySlash将重定向请求。发生这种情况时,您的布局会暴露,并且无法正常工作。例如,如果test下有一个目录/api/,并且您请求http://domain.com/test,它将被重写为/api/test,而mod_dir将看到“test”是一个目录但是没有尾部斜杠,因此mod_dir会(错误地)将浏览器重定向到http://domain.com/api/test/,并使用尾部斜杠但公开/api/