HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様

今日では HTTP(s) で API が公開されることは当たり前の時代ですが、エラーをアプリケーションにどう伝えるかは、個々の API の設計に依存していました。特に、HTTP ステータスコードは有限であり、元々持っている意味があるので、自由に使うことはできません。API はそのドメインごとにもっと複雑で細かなエラー情報があるはずで、それらはレスポンスボディに載せてアプリケーションに伝えることになりますが、その書式に規定は今までありませんでした。 HTTP API にて、アプリケーションにエラー情報を伝達するための（レスポンスボディに載せられる）標準的な形式が、RFC7807 Problem Details for HTTP APIs で定められています。適用例としては、以下のようになります。 HTTP/1.1 403 Forbidden Content-Type: application

[abracadabra321]

RESTful信者のコメントを期待

[masatomo-m]

多分あちこちで車輪の再発明がされまくっていた界隈なので、RFCになるというのには意味がある。既存アプリはこのままでいいけど新規開発アプリでは参考にしてみよう

[kiririmode]

エラー情報の表現。ステータスコードのみで充足するエラーとの使い分けが難しい…

[takaesu]

RFC7807

[igrep]

REST APIでエラーの詳細を伝える際の標準フォーマット。結構サービス毎にバラバラやもんなぁ。

[aroma_black]

“HTTP API にて、アプリケーションにエラー情報を伝達するための（レスポンスボディに載せられる）標準的な形式が、RFC7807 Problem Details for HTTP APIs で定められています。”

[griefworker]

RFCがあるのか。

[tmatsuu]

ほう

[Dai_Kamijo]

"HTTP API にて、アプリケーションにエラー情報を伝達するための（レスポンスボディに載せられる）標準的な形式が、RFC7807で定められています" 日本語訳ありがたい。正しく活用していきたい。 / “HTTP APIの詳細…”

[naga_sawa]

RFC 7807/WebAPIのエラー応答のフォーマット仕様

[satococoa]

RFC7807 Problem Details for HTTP APIs

[mallowlabs]

RFC7807

[bigwest]

[api][rfc]

[tinsep19]

Members of a Problem Details Object instance。特定の問題の発生を示すURI参照。参照先のデータを取得した際には、更なる情報を得られる可能性があります。

[kosh04]

RFC7807 Problem Details for HTTP APIs について

[temmings]

翻訳ありがたや

[june29]

要チェック。

[todesking]

RFC7807 HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様

[takatama]

助かる

[gakkie]

知らなかった！知っておくべきだった！

[Hiroto-K]

こんなのあるんだ

[hevohevo]

へぇー。“403 Forbidden”したうえで、さらに細かくJSONで情報を出すわけか。勉強になる。

[kyrie_leison]

API におけるエラー表現の標準を定義するのが RFC7870 Problem Details for HTTP APIs で、API のエラーを body 中の problem type として表現する

[blueberrystream]

RFC7807 Problem Details for HTTP APIs

[naoharu]

知らんかった。。、例を見ると「アプリケーションにエラー情報を伝達する」というよりかは「デベロッパーにエラー情報を伝達する」というためのものに見える

[windish]

ほおお "application/problem+json" とな。

[glat_design]

あとで読む /

[somemo]

“Content-Type: application/problem+json”

[delphinus35]

こんなのあったのか！対応したい

[deep_one]

「RFC7807」

[dekasasaki]

へえ。