Skip to Content
Web API: The Good Parts
book

Web API: The Good Parts

by 水野 貴明
November 2014
Intermediate 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.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Principles of Web API Design: Delivering Value with APIs and Microservices

Principles of Web API Design: Delivering Value with APIs and Microservices

James Higginbotham
API Design Patterns

API Design Patterns

John J. Geewax
Designing APIs with Swagger and OpenAPI

Designing APIs with Swagger and OpenAPI

Lukas Rosenstock, Joshua Ponelat

Publisher Resources

ISBN: 9784873116860Other