API の失敗パターンを洗い出す
収録 2026-11-01
タイムアウト・部分成功・二重送信など、呼び出し側が遭遇する失敗を先に定義します。
API 定義があります。1）失敗パターン五つ（タイムアウト・部分成功・二重送信・権限切れ・下流停止）；2）各々で呼び出し側が見えるものと、返すべきステータスやエラーコード；3）呼び出し側の正しい戦略（再試行・諦める・突合・縮退）；4）開発者が見落とし本番で初めて気づくもの；5）ドキュメントに書ける一文。「500 を返す」だけにしない。
当サイトオリジナル
中国語の原文
使い方
接口文档里没写的失败，线上都会出现。
こう変えてみる
- コードを書く前に要件と制約を復唱させる。
- 全体書き換えではなく、最小の変更とロールバック方法を出させる。
得られる成果物
- そのまま使える最小変更（コピー可能なコード）
- 影響範囲：変更ファイルと追従が必要な呼び出し元
よくある失敗
- 一度に十ファイル変更させ、何が原因か分からなくなる。
- エラーだけ貼ってコードとバージョンを省くと、使えない修正が返る。
出力のチェック
- 変更は動いて戻せて、無関係なコードに手を入れていない。
- 境界条件（空・巨大・同時実行）が説明かテストで押さえられている。
使いどころと注意
- 向いている用途：要件と制約を復唱させてから、最小限の動く変更を出させる。
- 注意：エラーにはバージョンと最小再現を添える。無いと一見もっともらしいが合わない修正が返る。