Werner Vogels – 良いAPIデザインのために学んだ6つのこと

 (aws.amazon.com)
30 ポイント 投稿者 xguru 2022-01-26 | 4件のコメント | WhatsAppで共有
  • 「AWSが15年間で学んだ良いAPIを作るための6つの原則」についてのメモ

  1. APIは永遠である！

  2. 後方互換性を守ってください。

  3. 顧客のユースケースから逆算して作ってください。

  4. エラーが明示的なAPIを作ってください。

  5. 目的と使い方をすぐに理解できるAPIを作ってください。

  6. 実装の詳細が漏れないように注意してください。

  • 初期のAPI設計で陥りがちなミス

  • Smithyを通じて拡張性の高いAPIを作ること

関連記事

4件のコメント

 
xguru 2022-01-30
 
edunga1 2022-01-26

私は5番が響きました。

参照されている「そんなREST APIで大丈夫か」は以前見たことがありますが、良かったです: https://tv.naver.com/v/2292653

こういうセマンティック？な情報はあまり気にしていないのですが、GitHub APIを見るとこうした情報もしっかり返してくれていて、よく作られているという印象を受けます。
 
ehlegeth 2022-01-26

良い内容だと思います。

特に1番と4番は、レビューをするときにいつも話題にする項目のようですね。

3番は、Joshua Bloch が話していた "Write to Your API Early and Often" と通じる部分があるように思います。 (https://www.youtube.com/watch?v=aAb7hSCtvGw)
 
nicewook 2022-01-26

こうして整理しておくと当然のことのように見えますが、実際にやるときにはまた同じ失敗を繰り返してしまうものだと感じます。