YappoLogs: 2014年に向けた JSON API の実装の方向性と X-JSON-Status 改め X-API-Status header のご提案

2014年に向けた JSON API の実装の方向性と X-JSON-Status 改め X-API-Status header のご提案 追記 2014/11/20 14:00:00 わりと JSON やら XML やら各種フォーマットで API を運用している環境がある場合に JSON API の時だけ X-JSON-Status にすると XML とかの時と整合性取れないし、 X-XML-Status みたいのを量産するのは困る的なレビューを頂いたので X-JSON-Status をやめて X-API-Status にしました。 へたに JSON に限定するから REST とか JSON-RPC とかいわれるんや！ X-API-Status にしたら全部解決したし MessagePack な API でも使い回せるって songmu さん言ってた！ XML とかからどうやって引っこ抜

[mattn]

中野 status code

[escape_artist]

＼JSON の中野／

[y-kawaz]

新しいヘッダ考えるとCORS対応で面倒なことになるんだよな。多分 "Access-Control-Expose-Headers: X-JSON-Status" とかも一緒に返してやらないといけない。JSONPなら気にしなくて良いけどその場合そもそもステータスコード関係無いか。

[yohei]

必要なら拡張ヘッダを使えばいいと思うけど、エラーを200で返すのはやめてほしい

[rryu]

APIがRESTじゃなくてover HTTP的なプロトコルになってきたらHTTPのステータスとAPIのステータスは分けないとややこしくなってくる感じ。

[Jxck]

こういう「オレオレルール」を減らそうぜっていうのが REST のモチベーションの一つだけど、 REST はあくまでスタイルの一つなので、それで運用負荷が下がるならそれでいいと思う。

[studio-m]

/user/123みたいなAPIで404を返すと、id:123なリソースが存在しないのか、end point間違えたのか判別しづらいから、こういうの便利そう

[s025236]

“ JSON の中野 status code”が気になってしょうがない。ヘッダー追加は実装楽そうだしいいかも

[xoyip]

なるほどー

[takatoshiono]

参考に

[raimon49]

JSONの中にステータスコード入れてしまう問題。

[auient]

JSON APIの設計について

[cachico]

YappoLogs: 2014年に向けた JSON API の実装の方向性と X-JSON-Status header のご提案

[naga_sawa]

HTTP APIのエラーの返し方/オレオレルールとしては、HTTPステータスコードで大分類な状態を返して細かいのはResponseBodyにJSONで返すようにしてる/運用面を考えると拡張ヘッダにも返すようにしてもいいかもしれない

[aklaswad]

ジェイソン中野ってはじめの一歩の登場人物だっけ？

[ono_matope]

前のプロダクトの時にエラーメッセージヘッダに詰めちゃおうぜとか言ってたなあ。結局やらなかったけど、標準的になったら便利かもしれない

[teckl]

これは良さそう。200の中のjsonでエラー返すのはやっぱアレなのかなぁ・・

[lesamoureuses]

jsonのstatus codeむずい

[moronbee]

" HTTP status code と X-JSON-Status をみるだけで respnse の状態がわかる感じ" // なるほどよさげ。

[potato777]

アプリケーションレイヤーのエラーコードも access log に含めるために、X-JSON-Status というヘッダーを提案する。という話。/ これなら JSON に限定しなくてもいいと思うけど

[hoisjp]

あるある

[wyukawa]

ふうむ。おれが見たケースだとエラー時も200返してjsonの中にエラー内容出力してた気がする。

[kazuph1986]

運用まできっちり考えてるっぽい。

[tkawa]

「HTML based な Web Application においては、 client からの入力データの不備は 200 OK で返した上でエラーの状態を HTML の中に記載して返してるではありませんか」400か422が適切。（例えばRailsのデフォルトはそうなっている）

[yyamano]

200を返すとキャッシュで困らないんだろうか?

[yanbe]

よさそう

[tsucchi1022]

現在HTTPステータスがおかしい所でも互換性をほとんど崩さずに改善できそうなので良さそう

[griefworker]

JSON APIのステータスコードを X-JSON-Statusヘッダで返すという手法。

[lizy]

REST over HTTP的に1レイヤ上に置く？

[overlast]

"JSON の中野 status code を X-JSON-Status というヘッダで出力する"

[uzulla]

ログにだすのよさそう、でも「JSONのステータスコード」はやっぱり各社独自になっちゃうかなー、HTTPのやつを流用する想定なのかな。

[karupanerura]

よさそう