4章HTTPの仕様を最大限利用する
1章でも述べたように、公開するAPIの仕様や挙動を決定する際の原則の1つとして、既存の標準仕様を遵守することと、デファクトスタンダードはできるかぎり守ることがあげられます。Web APIはHTTP上で通信を行うので、HTTPの仕様をしっかりと理解して、それを活用したほうがより使い勝手がよいものとなります。
4.1 HTTPの仕様を利用する意義
HTTPをはじめとして、インターネット上で利用される仕様の多くはRFC(Request for Comments)と呼ばれる仕様書で定義されています。HTTPはその最新版であるバージョン1.1はRFC 7230†1から始まる一連の文書群で定義されています。RFC 7230は2014年6月に発行された新しいRFCですが、これはHTTPのバージョン1.1の最初のRFCではなく、RFC 2616という1999年に発行されたRFCを更新するものです。RFCはそのルールとして新しく仕様を変更したり追加したりする場合は、新しいRFCを発行して古いものを上書きすることになっているからです。HTTPに関する仕様はこれ以外にも、たとえばPATCHメソッドに関するRFC 5789、新たなステータスコードを追加したRFC 6585などがあります。こうした仕様は全世界に公開されており、HTTPを使った数多くのやりとりの基礎を築いています。ですからWeb APIを設計する上でも、こうした仕様をよく理解することで不本意に独自仕様を入れてしまう危険性が減ります。
標準の仕様をできるかぎり利用して作られたAPIは第三者にとっても、少なくとも独自仕様に比べればずっと理解しやすいはずで、利用時のバグの混入を減らしたり、あなたのAPIが広く使われる、あるいはすでに存在するライブラリやコードが再利用可能になる可能性がずっと高くなります。 ...