REST APIに正しいContent-Typeを選ぶ

REST APIのリクエストとレスポンスに適切なContent-Typeヘッダーを選択するガイド。JSON、フォームデータ、multipartなどをカバー。

Application Types

詳細な説明

REST APIのContent-Typeヘッダー

Content-TypeヘッダーはAPIにとって重要で、サーバーにリクエストボディの解析方法を、クライアントにレスポンスの解析方法を伝えます。

一般的なAPI Content-Type

Content-Type 使用タイミング
application/json JSONリクエスト/レスポンスボディ(最も一般的)
application/x-www-form-urlencoded シンプルなHTMLフォーム送信
multipart/form-data メタデータ付きファイルアップロード
application/xml SOAPまたはレガシーXML API

Acceptヘッダーによるコンテントネゴシエーション

Accept: application/json

エラーレスポンス

RFC 7807は標準化されたエラーオブジェクトのためにapplication/problem+jsonを定義しています。

ユースケース

REST APIを設計または利用する際にこの知識を適用します。ほとんどのモダンAPIにapplication/jsonを、シンプルなフォーム送信にapplication/x-www-form-urlencodedを、ファイルアップロードを含むリクエストにmultipart/form-dataを使用します。

試してみる — MIME Type Reference

フルツールを開く