泥水エンジニア日記

泥水の数だけ強くなれる

『Web API The Good Parts』を読んだ

API の設計する機会も増えてきたので。これまでにも何度かリファレンス的に読んでた本なんだけど、微妙に誤読してるところとかあって、そういうんじゃダメだよね、と思って通読してみました。API 設計におけるバイブル的な一冊。

Web API: The Good Parts

Web API: The Good Parts

  • エンドポイントの URI はどんな感じにしたら分かりやすい?
  • レスポンスデータはどうするのがベスト?
  • クライアントに対するエラー表示は?
  • セキュリティ的に気をつけるポイントは?

などなど、API を設計する際に悩むポイントは色々あると思うんだけど、『Web API The Good Parts』では、「広く公開されている API ではどう対応しているか」「HTTP の仕様と照らし合わせて適切か」を分かりやすくまとめてくれていて、設計思想の拠り所になってくれる。

オライリーの本だけど、変な日本語訳もなく、ページ数も 200 ページと少なめなのでとても読みやすい。とても有名な本なので Qiita に要約があったり、ブログにまとめが載っていたりするけれど、この本については原典にあたることをオススメします。手元に置いておいてチラ見するのでもいいけど。

尺が余ったので目次を引用してお茶を濁します。

  • Web API とは何か
  • エンドポイントの設計とリクエストの形式
  • レスポンスデータの設計
  • HTTP の仕様を最大限利用する
  • 設計変更をしやすい Web API を作る
  • 堅牢な Web API を作る

いい章立てですね。読書メモ置いておきます。

API 設計についてモヤモヤした気持ちを抱えている人は手に取ってみるといいんじゃないでしょうか。