使用子域名对REST API进行版本控制

Question

我刚完成了我们企业应用程序的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/

- Kevin Rave

Answer 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]

前两个规则基本上是为后两个规则复制的，但第一个将www*（或无内容）映射到/api/，第二个处理映射到目录的子域名（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/。

- Jon Lin