Content-TypeとAcceptヘッダー

レスポンスは本文だけではありません。HTTPヘッダーが本文について説明し、その中でも2つのヘッダーがクライアントとサーバー間でJSONがどうやり取りされるかを決めます。📨

Content-Typeヘッダーは、送信する本文の形式を示します。JSONレスポンスの場合、その値はapplication/jsonです。

このヘッダーを手動で設定することはほとんどありません。jsonifyを呼び出すと、Flaskがapplication/jsonを自動的に付加するため、クライアントは常に正しく解析できます。

ブラウザーやライブラリはContent-Typeを読み、本文の扱い方を決めます。application/jsonであることが分かると、テキストを使用可能なオブジェクトに解析します。

JSONテキストをtext/htmlのプレーンテキストとして返すと、クライアントが解析できないことがあります。本文が正しく見えても、必要な情報がないため自動デコードに失敗します。

リクエストには、クライアントが求める形式を列挙したAcceptヘッダーを含められます。これは希望を伝えるもので、どのレスポンス形式が最適かをサーバーに知らせます。

この2つを正しく区別しましょう。Content-Typeは現在のメッセージの本文を説明し、Acceptはクライアントが返してほしい形式を示します。

リクエストを調べて、呼び出し元の希望に応えることができます。request.accept_mimetypesプロキシから、そのヘッダーに列挙された形式を確認できます。

クライアントが要求した形式で提供することをコンテンツネゴシエーションと呼びます。APIはAcceptに応じて、同じルートからJSONまたはHTMLを返せます。

受信するリクエストにもContent-Typeが含まれます。クライアントがapplication/jsonを送信すると、Flaskは本文がJSONであることを認識し、request.get_jsonで解析できます。

ほとんどのJSON APIでは、jsonifyがContent-Typeを処理してくれれば十分です。1つのルートで複数の形式を提供する必要がある場合にだけ、Acceptを利用しましょう。

Content-Typeは本文の形式を示し、Acceptは希望する形式を要求すること、そしてjsonifyがapplication/jsonを設定するため、JSONクライアントがそのまま動作することを学びました。🎉