概要
失敗時に返すステータスと本文の形を、成功時と同様に契約の一部として定めること。
HTTPステータスコード で大枠の意味を伝え、本文で原因・対処・識別子などの詳細を載せる。
OpenAPI の responses で 4xx/5xx を明示し、クライアントが分岐できるようにする。
形式を揃える代表例が Problem Details(application/problem+json)である。
失敗時に返すステータスと本文の形を、成功時と同様に契約の一部として定めること。
HTTPステータスコード で大枠の意味を伝え、本文で原因・対処・識別子などの詳細を載せる。
OpenAPI の responses で 4xx/5xx を明示し、クライアントが分岐できるようにする。
形式を揃える代表例が Problem Details(application/problem+json)である。