P253 9.1.6 見えないインターフェイスコントラクトに注意する

当頁は、APIドキュメントからは読み解けない仕様のことを説明してくれている。
例えば、ユーザーIDを連動させて、その内部仕様で住所を引っ張って来るような実装があったとする。
それが、自宅か勤務先かなどの区分を引き渡して、それを用いて実装されていたら問題無い。
しかし、これがインデックスの先頭とかを参照するとかであれば把握しきれない。
(ただ、これは見えない仕様というより実装がアンポンタンなだけな例ではあるが…)

とはいえ、知らぬ間にユーザーインタフェースだけでは分からない仕様は作りこんでしまう。
API設計者はその様にならない様に設計、ドキュメントで説明などしなければならない。
また、仕様追加などを行う際に、その様な部分にも影響を与えないかの配慮をしなければならない。