@suzu6

主にWEBと解析の技術について書きます。

広く浅くも続ければ深くなるはず。

【書評】RESTful APIを設計したくて「Web API The Good Parts」を読みました

WEB APIを使う機会が増えてきました。 サービス間の連携やモバイルアプリのバックエンドだけでなく、SPAによってウェブサービスにも使います。

最近制作したウェブサービスでも、ググりつつもかなり悩みながらURLやレスポンスを設計した。 このままではまずいなと思い、オライリーのWeb API: The Good Partsを読みました。 知りたかったことが詳細に書かれており、一冊を通して体系化された設計を学べたように思います。

book

Web API The Goog Parts

本書はWeb APIを開発する際して、どのように設計すればよいか、どのような点に気をつけて開発すればよいのかについて書かれた書籍です。

本書の設計思想は美しいAPIを目指している。 厳密なREST APIではなく、現実的なAPIを「美しく」設計することに主眼が置かれている。 ただ基本的な考え方は同じで、URIからレスポンスが想像できるわかり易さと、ステートフル、HTTPメソッドに応じたインターフェースとなる。 言及されていないがRESTful APIかな。 レスポンスボディはXMLではなくJSON形式。GraphQLの記述はなかったはず。

REST APIについてはWikiQiitaがわかりやすい。本書を読むのが一番良いが。

読んでわかることは大まかに以下の3つになるかと思います。

  1. WEB APIを公開するための設計思想
  2. 世にあるサービスの設計がどうなっているか
  3. Auth2.0やHTTPの仕様など、WEB APIに関する技術の解説

本書はURLの設計からレスポンスデータ、HTTPステータスの設計を解説しながら上記の3つを絡めている。 内輪のサービスではなく公開を前提として、利便性やセキュリティと文化的な面も考慮されている。 文化的な面は、広く使われている単語やインターフェースにしようねといった意味。 アプリケーション側の処理も想定しながら進むため、実際の開発現場で必要な要素が多々ある。 バージョンを変える際の指針なんかは知る機会が少ない。

フロントエンドにとってもどういったデータなら作りやすい・使いやすいものになるかを考えられる。 例えば、ユーザページとサイトのページネーションをどう実現するか。 これが、世にあるサービス(TwitterやFacebookなど)の設計を比較してまとまっています。 URIとレスポンスには各サービスの特徴や共通する点の解説もしてくれます。

HTTPの仕様の解説もありがたい。 レスポンスのステータスコード自体は知っていたが、使い方のイメージが曖昧だった。 HTTPの仕様はRFC (Reqest for Contents)にまとめられ日本語もあるが、全て読もうとは思えなかった。 RFCに言及してステータスコードとレスポンスヘッダの解説も十分にある。

APIを公開すること

本書ではサービスのAPIを公開することの重要性も説いています。 有名なところでは、TwitterがAPIを公開していることでサードパーティ製のアプリが増えユーザの利便性が高まりユーザが増えていきました。 また、APIの利用を前提としたサービスもありTwillioは電話の自動応答やSMS送信を提供している。

私自身、APIも含めて提供するサービスを夢想しています。 公開したら攻撃されそうでなんだか怖いと感じていました。 第6章では、APIのセキュリティ面の設計も解説があり大変助かりました。 本書では、APIを公開するに当たってのチェックシートも用意されています。 設計する際に、今一度読み返す。

おわりに

全体的に解説はとてもわかり易いです。 フレームワークに依らない基礎の技術を学ぶ上で、初心者の方にも参考になるかと。 文章は煮え切らないところと、少々細かすぎる嫌いがあります。 著者の苦悩もなんだか伝わってくる。

設計には普遍的な正解が無いように思うが、ベースとなる考え方と照らし合わせて個々のサービスのベストな設計をしていきたい。

Posted at 2019.07.15
O'REILLY
水野 貴明 著

こちらはAmazonのクラウドエンジニアが選ぶ技術書にも選ばれています。