blocks|key|413672|text|有几件事要补充：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|413673|你的重定向匹配对于某些路由是不起作用的--+*api参数是贪婪的，会吞噬所有东西，例如/api/asdf/users/1会重定向到/api/v2/1。您最好使用像:api这样的常规参数。诚然，它不能匹配像/api/asdf/asdf/users/1这样的情况，但是如果你的应用程序接口中有嵌套的资源，这是一个更好的解决方案。|offset|length|style|CODE|413674|为什么你不喜欢namespace？:-)，例如：|413675|current_api_routes+=+lambda+do
++resources+:users
end

namespace+:api+do
++scope+:module+=>+:v2,+&current_api_routes
++namespace+:v2,+&current_api_routes
++namespace+:v1,+&current_api_routes
++match+":api/*path",+:to+=>+redirect("/api/v2/%25{path}")
end|code-block|syntax|javascript|413676|这具有版本化和通用命名路由的附加好处。另请注意-使用:module时的约定是使用下划线表示法，例如：api/v1而不是'Api::V1‘。后者一度不起作用，但我相信它已经在Rails3.1中修复了。|413677|此外，当您发布API的v3时，路由将像这样更新：|413678|current_api_routes+=+lambda+do
++resources+:users
end

namespace+:api+do
++scope+:module+=>+:v3,+&current_api_routes
++namespace+:v3,+&current_api_routes
++namespace+:v2,+&current_api_routes
++namespace+:v1,+&current_api_routes
++match+":api/*path",+:to+=>+redirect("/api/v3/%25{path}")
end|413679|当然，您的API很可能在不同版本之间具有不同的路由，在这种情况下，您可以这样做：|413680|current_api_routes+=+lambda+do
++#+Define+latest+API
end

namespace+:api+do
++scope+:module+=>+:v3,+&current_api_routes
++namespace+:v3,+&current_api_routes

++namespace+:v2+do
++++#+Define+API+v2+routes
++end

++namespace+:v1+do
++++#+Define+API+v1+routes
++end

++match+":api/*path",+:to+=>+redirect("/api/v3/%25{path}")
end|413681|entityMap^0|0|M|4|17|H|1T|9|29|4|2U|M|0|7|9|0|0|Q|7|1E|6|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|10|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|11|8|@$D|12|E|13|F|G]|$D|14|E|15|F|G]|$D|16|E|17|F|G]|$D|18|E|19|F|G]|$D|1A|E|1B|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|1C|8|@$D|1D|E|1E|F|G]]|9|@]|A|$]]|$1|J|3|K|5|L|7|1F|8|@]|9|@]|A|$M|N]]|$1|O|3|P|5|6|7|1G|8|@$D|1H|E|1I|F|G]|$D|1J|E|1K|F|G]]|9|@]|A|$]]|$1|Q|3|R|5|6|7|1L|8|@]|9|@]|A|$]]|$1|S|3|T|5|L|7|1M|8|@]|9|@]|A|$M|N]]|$1|U|3|V|5|6|7|1N|8|@]|9|@]|A|$]]|$1|W|3|X|5|L|7|1O|8|@]|9|@]|A|$M|N]]|$1|Y|3|-4|5|6|7|1P|8|@]|9|@]|A|$]]]|Z|$]]

A couple of things to add:

Your redirect match isn't going to work for certain routes - the <code>*api</code> param is greedy and will swallow up everything, e.g. <code>/api/asdf/users/1</code> will redirect to <code>/api/v2/1</code>. You'd be better off using a regular param like <code>:api</code>. Admittedly it won't match cases like <code>/api/asdf/asdf/users/1</code> but if you have nested resources in your api it's a better solution.

Ryan WHY U NO LIKE <code>namespace</code>? :-), e.g:

<pre><code>current_api_routes = lambda do
 resources :users
end

namespace :api do
 scope :module =&gt; :v2, &amp;current_api_routes
 namespace :v2, &amp;current_api_routes
 namespace :v1, &amp;current_api_routes
 match ":api/*path", :to =&gt; redirect("/api/v2/%{path}")
end
</code></pre>

Which has the added benefit of versioned and generic named routes. One additional note - the convention when using <code>:module</code> is to use underscore notation, e.g: <code>api/v1</code> not 'Api::V1'. At one point the latter didn't work but I believe it was fixed in Rails 3.1.

Also, when you release v3 of your API the routes would be updated like this:

<pre><code>current_api_routes = lambda do
 resources :users
end

namespace :api do
 scope :module =&gt; :v3, &amp;current_api_routes
 namespace :v3, &amp;current_api_routes
 namespace :v2, &amp;current_api_routes
 namespace :v1, &amp;current_api_routes
 match ":api/*path", :to =&gt; redirect("/api/v3/%{path}")
end
</code></pre>

Of course it's likely that your API has different routes between versions in which case you can do this:

<pre><code>current_api_routes = lambda do
 # Define latest API
end

namespace :api do
 scope :module =&gt; :v3, &amp;current_api_routes
 namespace :v3, &amp;current_api_routes

 namespace :v2 do
 # Define API v2 routes
 end

 namespace :v1 do
 # Define API v1 routes
 end

 match ":api/*path", :to =&gt; redirect("/api/v3/%{path}")
end
</code></pre>

blocks|key|413730|text|如果可能的话，我建议您重新考虑您的url，这样版本就不在url中，而是放在accepts头中。这个堆栈溢出的答案很好地解释了这个问题：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|413731|Best+practices+for+API+versioning?|offset|length|413732|这个链接准确地展示了如何使用rails路由实现这一点：|413733|http://freelancing-gods.com/posts/versioning_your_ap_is|413734|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/questions/389169/best-practices-for-api-versioning|1^0|0|0|Y|0|0|0|0|1J|1|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|T|8|@]|9|@$D|U|E|V|1|W]]|A|$]]|$1|F|3|G|5|6|7|X|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|Y|8|@]|9|@$D|Z|E|10|1|11]]|A|$]]|$1|J|3|-4|5|6|7|12|8|@]|9|@]|A|$]]]|K|$L|$5|M|N|O|A|$P|Q]]|R|$5|M|N|O|A|$P|I]]]]

If at all possible, I would suggest rethinking your urls so that the version isn't in the url, but is put into the accepts header. This stack overflow answer goes into it well:

<a href="https://stackoverflow.com/questions/389169/best-practices-for-api-versioning">Best practices for API versioning?</a>

and this link shows exactly how to do that with rails routing:

<a href="http://freelancing-gods.com/posts/versioning_your_ap_is" rel="nofollow noreferrer">http://freelancing-gods.com/posts/versioning_your_ap_is</a>

blocks|key|628991|text|我对按路由进行版本控制不是很感兴趣。我们构建VersionCake是为了支持更简单的应用程序接口版本控制。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|628992|通过在每个视图(jbuilder，RABL等)的文件名中包含API版本号，我们保持了版本控制的简洁性，并允许容易降级以支持向后兼容(例如，如果视图的v5不存在，我们将呈现视图的v4+)。|628993|entityMap|0|LINK|mutability|MUTABLE|url|https://www.github.com/bwillis/versioncake^0|M|B|0|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@$A|O|B|P|1|Q]]|C|$]]|$1|D|3|E|5|6|7|R|8|@]|9|@]|C|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]]]

I'm not a big fan of versioning by routes. We built <a href="https://www.github.com/bwillis/versioncake">VersionCake</a> to support an easier form of API versioning. 

By including the API version number in the filename of each of our respective views (jbuilder, RABL, etc), we keep the versioning unobtrusive and allow for easy degradation to support backwards compatibility (e.g. if v5 of the view doesn't exist, we render v4 of the view).

blocks|key|413842|text|Ryan+Bigg+answer对我很有效。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|413843|如果您还想通过重定向保留查询参数，可以这样做：|413844|match+"*path",+to:+redirect{+%7Cparams,+request%7C+"/api/v2/#{params[:path]}?#{request.query_string}"+}|code-block|syntax|javascript|413845|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|L|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|M|8|@]|9|@]|A|$G|H]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

Ryan Bigg answer worked for me.

If you also want to keep query parameters through the redirect, you can do it like this:

<pre><code>match "*path", to: redirect{ |params, request| "/api/v2/#{params[:path]}?#{request.query_string}" }
</code></pre>

I'm trying to version my API like Stripe has. Below is given the latest API version is 2.

<code>/api/users</code> returns a 301 to <code>/api/v2/users</code>

<code>/api/v1/users</code> returns a 200 of users index at version 1

<code>/api/v3/users</code> returns a 301 to <code>/api/v2/users</code>

<code>/api/asdf/users</code> returns a 301 to <code>/api/v2/users</code>

So that basically anything that doesn't specify the version links to the latest unless the specified version exists then redirect to it.

This is what I have so far:

<pre><code>scope 'api', :format =&gt; :json do
 scope 'v:api_version', :api_version =&gt; /[12]/ do
 resources :users
 end

 match '/*path', :to =&gt; redirect { |params| "/api/v2/#{params[:path]}" }
end
</code></pre>

API Versioning for Rails Routes

路由

我正试着像Stripe一样对我的API进行版本控制。下面给出的是最新的API版本为2。/api/users向/api/v2/users返回301/api/v1/users返回版本1的200个用户索引/api/v3/users向/api/v2/users返回301/api/asdf/users向/api/v2/users...

问Rails路由的API版本控制
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Rails路由的API版本控制EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Rails路由的API版本控制
EN