Skip to Main Content
Web API: The Good Parts
book

Web API: The Good Parts

by 水野 貴明
November 2014
Intermediate to advanced content levelIntermediate to advanced
224 pages
3h 22m
Japanese
O'Reilly Japan, Inc.
Content preview from Web API: The Good Parts

3章レスポンスデータの設計

前章ではWeb APIへのリクエストの設計を見てきました。続いて本章ではリクエストの結果返されるレスポンスデータをいかに設計するかについて見ていくことにします。Web APIは簡単に言えばHTMLの代わりによりプログラムで処理をしやすいデータ形式を返すウェブページの一種です。したがってレスポンスデータはできうるかぎりプログラムで処理をしやすいものであるべきです。本章では美しいレスポンスデータとは何か、どうすればよりプログラムで処理をしやすいレスポンスデータとなるかについて考えます。

3.1 データフォーマット

まず最初に考えるべきは、どういったデータフォーマットを採用するかです。ここでいうデータフォーマットとはAPIが返す構造化データをどのような表現で返すかということで、具体的に言うとJSONやXMLのことを意味します。

これに関しては実はあまり検討の余地はなく、JSONにデフォルトとして対応し、需要や必要があればXMLに対応する、というのが最も現実に即しています。というのも、世の中のAPIのデファクトスタンダードは完全にJSONになったといえるからです。現在よく使われているWeb APIを見ても、JSONに対応していないAPIはかなり少数派ですが、XMLに対応していない(というよりもJSONのみに対応している)APIは最近では非常に多くなってきました。TwitterではAPIのバージョン 1.1からJSONのみとなりましたし、YelpやFoursquare、TumblrもAPIのバージョン2.0からはJSONのみになりました。このようにAPIのアップデートとともにJSONのみに切り替わるサービスも数多く見受けられ、もはやJSONさえサポートしていれば問題はない状況になったといえます( ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

RESTful Web API Patterns and Practices Cookbook

RESTful Web API Patterns and Practices Cookbook

Mike Amundsen
API Design Patterns

API Design Patterns

John J. Geewax

Publisher Resources

ISBN: 9784873116860Other