3

刚刚为我们的企业应用程序完成了第一个版本的 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/
4

1 回答 1

1

我想知道这是否是一个好习惯。有什么注意事项吗?

如果您的意思是一种版本控制和部署 REST API 的方式,我认为这很好。至于为此使用 htaccess 路由,有一些警告可能会通过其他域访问不同的 API,尽管这将取决于您的服务器配置而不是规则。例如,如果设置了默认虚拟主机,则有人可能能够通过http://123.45.67.89/apiv1-0/.

如何设置“.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 条规则几乎重复,但第 2 条规则将www*(或没有)映射到/api/,而第 2 条规则处理映射到目录的子域(apiv1-0 .domain.com映射到/apiv1-0/.

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

于 2012-08-28T22:23:13.427 回答