フロントエンドのバックエンドの変更を回避するための良いプロセスは何ですか？

Question

私たちはバックエンドの人たちがエンドポイントを絶えず変更しているプロジェクトを持っています。フロントエンドでは、バックエンドの人と話をした後、新しい変更があることが判明しました。

このバグは、追跡が難しく時間が浪費することがあります。ある日、私たちのコードが動作してから、RESTfulなAPIが変更されたので、私たちのコードはもはや動作していないことがわかります。

これを避けるための良い方法はありますか？これを避けるための良いプロセスは何ですか？どのようにあなたの会社でそれを行うのですか？

Answer 1

バージョン番号のAPIが必要です。新しいバックエンド機能やバックエンドの変更には、新しいAPIバージョン番号が付いてくるはずです。古いAPIバージョン番号は常に同じ結果をそのまま返します。

バックエンドを変更した場合は、新しいバージョンのAPIを使用して、使用する必要がある新しいバージョンがあることを通知することができます。

私がクライアントソフトウェアで使用する追加のアプローチ（エンドユーザーにソフトウェアのアップグレードを強制することができないため、これはさらに重要です）：サーバーから取得したすべてと、私はそれが期待される方法は、開発者のマシンに記録されます。したがって、サーバーが私に送信する内容を変更した場合、私は非常に迅速にわかります（そして、エンドユーザーに影響を及ぼす場合は支払いが面倒です）。

Answer 2

私は@ gnasher729答えを受け入れる。しかし、REST APIをバージョン化していない場合は、この種の問題を処理するために別の方法を実行する必要があります。

REST APIの変更点を伝達するために、以下のアプローチに従います。これが他の人たちにも役立つことを願っています。

各Webサービスのサンプル要求と応答を含む中央の場所（Git/Project Central）にREST API定義ドキュメントとWADLを保持します。したがって、このドキュメントは、新しいサービスを追加したり、スキーマを変更したりするたびに、バックエンドチームによって頻繁に更新されるでしょう。したがって、このドキュメントを定期的に参照することで、フロントエンドチームはAPIの最近の変更について知ることができます。