読者です 読者をやめる 読者になる 読者になる

$shibayu36->blog;

株式会社はてなでエンジニアをしています。プログラミングや読書のことなどについて書いています。

Web API: The Good Parts読んだ

APIの良い設計手法を学びたいと思って、「Web API: The Good Parts」読んだ。

Web API: The Good Parts

Web API: The Good Parts

この本は設計の美しいAPIはどのようなものかについていろいろ解説してくれる。APIにまつわることは様々な範囲で教えてくれて、必要最低限のHTTPの知識やAPI周りのセキュリティの話も学ぶことが出来る。これからスマホ用などの内部でのJSON APIを作りたい人や、外部向けの公開APIを作りたい人にはおすすめ。

今回は以下のようなことが勉強になった。ページ番号も書いておくので参照のこと。参考になりそうなURLも一緒につけておいた

  • LSUDsとSSKDs 17
  • APIで使われる単語を知るためには他のAPIを見てみるのが良い -> ProgrammableWebとか 24
  • エンドポイントの基本的な設計 22
    • 短く入力しやすい/冗長性のない
    • 人間が読んで理解できる/変な省略などがない
    • 大文字小文字が混在していない/単語区切りはハイフン、アンダースコア
    • 改造しやすい
    • サーバ側のアーキテクチャが反映されていない/インターフェースとアーキテクチャは違う
    • ルールが統一されている/クエリとかパスとかの流儀が統一されていない
  • リソースにアクセスするためのエンドポイントの設計の注意点 39
    • 複数形の名詞を利用する
    • 利用する単語に気をつける
    • スペースやエンコードを必要とする文字を使わない
    • 単語を繋げる必要がある場合はハイフンを利用する(?)
  • HATEOAS 60
  • JSONハイジャックの手法とその対策 169, 171
  • セキュリティ関係のHTTPヘッダ 178