ウェブサービス・APIのリソース設計

Web を支える技術 -HTTP、URI、HTML、そして REST (WEB+DB PRESS plus)という本の 15 章以降で、郵便番号検索サービスを例にとって、設計の具体的手法が書いてあったので、その中で重要だと思ったことをまとめました。ここでいう“設計”とはリソース設計のことになります。リソース設計は、クライアント／サーバー間のインターフェースの設計、すなわち Web サービスや Web API の外部設計のことを指します。

リソース設計をするときに大切なことは、Web サービスと API を分けて考えないことが大切だそうです。両者は人間用、プログラム用と用途は違うものの、どちらも同じ Web 技術を使ったインターフェースだからです。

ソフトウェア開発にはさまざまな設計手法がありますが、リソース設計にはまだ一般的な設計手法が存在しないそうで、設計の指針として唯一「RESTful Web サービス」の中で「リソース指向アーキテクチャ」というものが推奨されている程度です。これは次のようなステップで設計していく方法です。