リソース指向Web APIのレスポンス設計
RESTなどリソース指向のWeb APIのレスポンス構造を設計するときに考慮すること
同じ概念(リソース)は同じ構造(スキーマ)で表現する
どのエンドポイントでも整合性のある情報を返す
リソースを小さく保ち、コンポジションで表現する
上位の概念は継承ではなくコンポジションで表現する
ライフサイクルの違うデータもコンポジションで表現する
ときにはリソースを直和型として捉える
クライアントアプリケーションを記述する言語の多くは代数的データ型を備えている
TypeScript, Kotlin, Swift
参考
アプリクライアントがリソース指向なサーバAPI設計に期待すること
APIレスポンスにおける直和型の表現を考える