うさぎ組

ソフトウェア開発、チームによる製品開発、アジャイル、ソフトウェアテスト

Web API The Good PartsはWeb API開発必携の書籍でした。 #apijp

はじめに

これはWeb API Advent Calendar 2014の二日目の記事です。 明日はid:nobusueさんです。

概要

これはWeb API The Good Partsという書籍の感想です。Web API開発に関わる人なら必ず読んでおいたほうがいいでしょう。ここ3年くらい「URI設計はどうすべきなのか」「APIバージョンはどうすべきなのか」「続きのデータをどのように取得すべきなのか」などについて綺麗にまとまっています。 最後にWEB API開発やレビューで使いたいチェックリストがあるのも素晴らしいです。

Web API: The Good Parts

Web API: The Good Parts

全体

本書はWeb APIの設計、実装、レビュー、運用について細かく書かれています。本書を読み終わった時にタイトルは「Clean Web API」というほうがよかったのではないかなぁとか思う感じの内容でした。 つまり、私達はどのようにしてよいWeb APIをつくっていくことが出来るのか?についてまとまっている書籍ということです。本当に素晴らしい書籍をありがとうございます。

以下では僕が気になった部分をピックアップしていきます。

導入が素晴らしかった

Web APIを開発するにあたって、どういった概念が既存にあり、どういったポリシーを持つべきかが平易に書かれていて読みやすかったです。また、RESTfulという言葉が曲解されて使われている現状を鑑みて、単なるXML over HTTPのようなAPIのことはRESTと呼ばないようにしているのも好印象でした。 Web API自体の関連企業についての紹介や、Web APIを導入する事自体についての説明も丁寧に書かれています。

エンドポイントとデータの設計

いくどもTwitterで「URIをどのように設計すべきか」などが議論されていたのを見ましたが、(網羅されているかはわかりませんが)本書では綺麗にまとめられていました。命名規約のようなものから、クエリとパスの使い分け、有効期限の使い方などなど。

データに関してもよく使いそうな性別などの例が出ていましたが、個人的にはエラーをどのように表現すべきかについてはこのようにまとまっていると嬉しい情報でした。

テストに関しても言及があった

大量アクセスやセキュリティに関する言及もあり、最低限このようなことを気にかけて設計すべきなのであるなぁと思いました。本書の最初の方にあるように、どの程度クローズドなAPIであるかによって全然意識が違うと再認識させられました。

まとめ

歴戦のWeb API開発者にはいらないのかもしれませんが、これからやってみようという方や、なんとなくやっているなーと不安を覚える方は読んでみるといいと思います!