インターフェースカタログを、システム間の契約と責任者を継続的に管理する台帳として作ります。アーキテクチャ図と、実装、障害対応、変更計画に必要な詳細を結び付けます。
業務フローから始める
注文の履行など実際のプロセスをたどり、すべてのAPI呼び出し、イベント、ファイル転送、定期データ交換を列挙します。照合用エクスポートや手動復旧用インポートなど、見えにくい経路も含めます。
各インターフェースについて次を記録します。
- 安定した識別子、業務目的、送信元、利用側、責任を持つ連絡先。
- 方向、転送手段、エンドポイントまたはファイルの場所、バージョン管理されたスキーマへのリンク。
- データの所有主体、識別子、分類、アクセス方式。認証情報自体は保存しません。
- タイミングまたはスケジュール、想定量、ペイロード制限、合意済みのサービス期待値。
- 該当する場合のタイムアウト、再試行、重複、順序、エラー処理の規則。
- 監視、エスカレーション、互換性方針、廃止に関わる依存関係。