質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
URL

URL(ユニフォームリソースロケータ)とは、インターネット上のリソース(Webページや電子メールの宛先等)を特定するための形式的な記号の並びの事を言う。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

0回答

142閲覧

APIのバージョニング情報はどこに含めるべきか?

tomoyuki123

総合スコア273

URL

URL(ユニフォームリソースロケータ)とは、インターネット上のリソース(Webページや電子メールの宛先等)を特定するための形式的な記号の並びの事を言う。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

0クリップ

投稿2019/12/20 05:30

編集2020/06/17 01:24

APIのバージョニング情報の渡し方は色々あると思いますが、大きく2つがあるかと思います。

1, URLに埋め込む 2, ヘッダーに含める

最初はどちらでも同じではと思っていましたが考えると

1の場合だとルーティングごとに新しいバージョンのAPIを一から作成できて古い実装を直さなくていいのと、ロギングする際にURLにバージョンが記載されているので管理しやすい
(デメリットとして新しく実装する際にコピペが増える)

2のヘッダーに含めるメリットはURLが純粋にそのリソースを表せるので比較的綺麗にできるのと、1のメリットとは真逆ですが修正が限定的になること

目的やプロジェクトの場合によってどう使い分けるのがいいのでしょうか?
(完全に作り直す機会が多いようならURLに含めた方がいいかなど)

また社内のみで使うAPIと外部に公開するAPIでまた違って来るのでしょうか?
よろしくお願いします。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問