URL内のv1などのバージョン情報はどこで確認しますか

Question

飲食店の予約管理アプリを作成中です。
初めにAPI仕様書を作成しておりますが、表題のようなバージョン情報をURLに記載したいと思っております。
そのバージョン情報はどこで取得するのか教えて頂きたいです。
勉強不足で申し訳ありませんがお力添えいただけますでしょうか…
例）/api/v1/users/registration

Comments

[m.ts10806]

自身で作ってるなら自身の決め次第ではないでしょうか。

Answer 1

自分で作って自分で使うだけのAPIならバージョンなんか含めなくていい。
APIの仕様変更と呼び出す側の変更を同時にすればバージョンは不要。
開発中なんてどんどん変更するのでバージョンの意味がない。
バージョンが必要なのは「大規模で複数人で開発してる場合」と「他人が使う公開API」

これもネットの情報に騙されてるパターン。

Comments

[maisumakun]

仕様書を作るようなAPIなので、「自分自身の管轄ではないところとやり取りするもの」と判断しました。

Answer 2

そのバージョン情報はどこで取得するのか教えて頂きたいです。

それが必要になる状況がわかりません。

「APIのバージョンが変わる」ということは呼ぶ側の引数も変わるということが多く、呼ぶ側は一般に特定のバージョンを呼ぶように作りつけたコードを書きます。

バージョンを移行する際も、一定期間は旧バージョンと新バージョンのAPIを並行稼動させて、その間にAPIを呼ぶ側のコードを書き換えてもらう期間を取るものです。

Comments

[abrt29]

必要だとばかり思っていました…バージョン変更後はそのように行ってらっしゃるんですね！ありがとうございます！

Answer 3

APIの仕様次第です。
URLで呼び出されるWeb APIについてはURLがパラメータそのものとなっているケースが多いです。
バージョンも含ませるならバージョン自体もパラメータで、もはや「URLに含まれてるバージョンを呼び出す」こととイコールになるので、「そのバージョン情報はどこで取得するのか」は無粋な疑問です。
CDNとかはその方式がよくとられています。

つまりURLに入れたでしょ。パラメータとして使うんでしょ。
ということになります。

常に最新のみを提供するならバージョン情報を含ませる意味はありません。

やはりAPIの仕様次第です。

なぜURLに含める必要があるのか
含めた上で何に利用するのか

を考えてはいかがでしょうか。
手法から考えていて本質を見失っているように見えます。
howよりwhy/whatが先。
なんの用途も目的もないものなら入れるだけ無駄な情報です。

ご自身が作られているのなら尚更自分で決めるべきものです。

Comments

[abrt29]

分かりやすくご説明頂きありがとうございます。確かにコードを書く際、how優先で書いてた気がします。私自身も必要なのだとばかり思っていたのでモヤモヤが晴れました！

[m.ts10806]

回答を要約すると「他人なのでわからない。自分で決めて」ですよ。