ゑ： エンドポイントは、結果も約束。
この言葉の意味
APIの設計では、URLや送るデータだけでなく、成功時と失敗時に何を返すかも決めます。HTTPの状態コードと応答内容を整理すると、呼び出す側が状況に応じて処理しやすくなります。すべてを同じ成功扱いにせず、認証や入力の問題などを区別しましょう。
たとえば、こんな場面で
理解を助けるための仮の場面です。
よくある場面
APIの成功時の形式だけを決めると、対象がない場合や権限がない場合に、受け手が結果を見分けられなくなることがあります。
こう変えてみる
成功と失敗のステータス、本文、再試行の条件を決めます。HTTPや利用する仕組みの意味に合わせ、受け手が扱える例を共有して確認します。
自分に問いかける
受け手は応答を見て、成功・修正・待機を判断できますか。
今日の実践ヒント
一つのAPIについて、成功・入力不正・権限不足の場合の応答を確認しましょう。