ともブロ。

Rails, Vue.js, React.js, JavaScript等、日々学んだ技術・知識を備忘録的に記していきます。

【Rails】 APIのURLにつける「V1」の意味とは?

RailsAPIで利用する場合のURLで、

http://localhost:3000/api/v1/hoge

のように、v1などの数字を付ける場合が多い。

現在ジョインしている案件でもURLに付けているが、これまでそういう物としか考えずに詮索しなかったが、

気になって調べてみた。

APIは開発の時点で頻繁に仕様変更があるため、v1, v2などスイッチングしやすくするためにURLに付けるのだそう。

Railsの場合、

namespace :api do
  namespace :v1 do
  ...
  end
end

のように、namespaceを用いることでURLに情報を付与できる。

つまり、v1からv2にして機能更新したい時など、柔軟性を持たせることができる。

小ネタ的ではあるが、意味を持たない事象は存在しないことを改めて学んだ。