RESTful Web APIs 読書メモ(9)
RESTful Web APIs 読書メモ(8)
Chapter 8. Profiles
- アプリケーション特化の拡張機能に対するドキュメント化
アプリケーション特化の用語の定義、ドキュメント化
現在、一般的用いられていることは、大量のhuman-readableなドキュメントを作成すること
- APIドキュメントについてはRESTful(自己記述性メッセージ)でない
RESTful Web APIs 読書メモ(7)
Chapter 7. Pure hypermedia Design
- コレクションパターンは強力であるが、何でもかんでも使えるではない
MAZE+xmlのコレクションパターンでの表現(5章)
- どう見ても迷路ゲームのアプリケーションセマンティクスにマッチしていない
APIの設計方針として、汎用的なハイパーメディアを用いることができる
RESTful Web APIs 読書メモ(6)
Chapter 6. The Collection Pattern
- コレクションもまたリソース
- コレクションに含まれるリソースは"item"や"entry"、"member"と呼ばれる
- Pagenation
- 大量のコレクションメンバーを持つ場合、全てを一度に返すことは通常しない
- 最初の一部だけをコレクションとして返し、残りはrel="next"を付与したリンクだけを提供する
- nextはIANAで登録されている
- ほかにprev, first, lastもIANAで定義されている
- Collection+JSONはリレーションを明示的にサポートしてはいない
- 必要ならリレーションを組み込めばいい
ESTful Web APIs 読書メモ(5)
Chapter.5 Domain-Specific Designs
- ドメイン特化設計
- ドメイン特化のmedia-typeではなく、一般的なmedia-typeにアプリケーションセマンティクスを加える方が良い
- Aplication/vnd.xxx.Maze+XML
- API設計する際に平均的な開発者が最初に選択する
- RFC5988
- リンク間の関係を定義
- ドメイン特化のmedia-typeではなく、一般的なmedia-typeにアプリケーションセマンティクスを加える方が良い