API デザイン・パターン(エーピーアイデザインパターン)

本書 "API デザイン・パターン (API Design Patterns) " は、 Web API を構築するための一連の設計原則、安全かつ柔軟で再利用可能なパターンを提供するために書かれました。 Google Cloud Platform とその API 設計に取り組む著者が、

・ API の一貫性、拡張性、可用性を確保する方法について
・安全かつ柔軟で再利用可能な API パターン
・一般的な API の設計を改善する手法

について解説します。コード例は TypeScript で解説。詳細なシナリオ・図解により、 API 設計についての理解が深まります。

提供する API が他の開発者から信頼され、便利に使ってもらえるようにするためのベストプラクティスを提供します。

［本書まえがきより］
ソフトウェアが「うまく設計されている」とはどういうことなのか、「よく設計された Web API 」とは何か。
私は自分自身で答えを出そうとし、実際に使ってみた情報などを何年もかけ集約し、 Luke Sneeringer と私で Google のルールとして明文化し、それは最終的に AIP.dev (google.aip.dev) という形で提供することになりました。これらのルールはある種の法律のようなもので「何をすべきか」は書かれていても、「なぜそうすべきか」は書かれていません。この本で私が目指したのは実践的なガイドラインと、その理由を論理的に説明することです。この本で取り上げたトピックが、 API デザインという魅力的かつ複雑な世界において、多くの会話や将来の仕事のきっかけとなることを願っています。

［対象読者］ Web API を構築している人、構築する予定の人。 API を一般に公開することを検討している場合に本書は有用です。 JSON などのシリアライゼーション・フォーマットや一般的なストレージ知識、 HTTP とそのメソッド (GET や POST) に精通していることは本書を理解する助けとなります。
目次:
PART 1 はじめに
第 1 章 API 入門
第 2 章 API デザインパターン入門

PART 2 設計の原則
第 3 章 名前付け
第 4 章 リソースの範囲と階層
第 5 章 データ型とデフォルト値

PART 3 基礎編
第 6 章 リソース識別子
第 7 章 標準メソッド
第 8 章 部分的な更新と取り出し
第 9 章 カスタムメソッド
第 10 章 ロングランオペレーション
第 11 章 再実行可能ジョブ

PART 4 リソース間の関係
第 12 章 シングルトンサブリソース
第 13 章 相互参照
第 14 章 アソシエーションリソース
第 15 章 カスタムメソッド: add 、 remove
第 16 章 ポリモーフィズム

PART 5 コレクションの操作
第 17 章 コピーと移動
第 18 章 バッチ操作
第 19 章 条件に基づく削除
第 20 章 匿名書き込み
第 21 章 ページ分割
第 22 章 フィルタリング
第 23 章 インポートとエクスポート

PART 6 安心と安全
第 24 章 バージョンと互換性
第 25 章 論理削除
第 26 章 リクエストの重複実行回避
第 27 章 リクエストの検証
第 28 章 リソースリビジョン
第 29 章 リクエストの再試行
第 30 章 リクエストの認証