yohei-y:weblog: HTTP ステータスコードを正しく使おう

先月、ぐるなび API がリリースされていました。 ぐるなびさんの持っている膨大なデータベースに Web API を通して気軽にア クセスできるようになったのは、非常に喜ばしいし、その英断に感謝したいと 思います。 しかし、Web API 仕様書、特にエラー仕様を見てちょっとがっかりしました。 もう少し上手にデザインすれば、もっとよかったのに…、という思いです。 一度出してしまった API はそう簡単に変えられないと思いますが、 参考までに僕だったらどうするか、を書いてみます。 この仕様の一番の問題はエラーコードです。 以下は 2-2 のエラー仕様に記述されているサンプルです。 <?xml version="1.0" encoding="UTF-8"?> <gnavi> <error> <code>602</code> </error> </gnavi> タグが三つ(gnavi, erro

[hiroomi]

標準とのすり合わせ。

[webmarksjp]

dev

[komagata]

APIのエラー設計に悩んでたので参考にしよう。

[hiromark]

確かにそう思う。

[japanrock]

604

[wacky]

Web APIにおけるエラーコード再発明の問題。ぐるなびの例。『単なるHTTPクライアントではなく、ぐるなびのエラーコードを実装した専用クライアントが必要になってしまう』

[sho]

正解と言い切れないとは思うが、美しい実装のアイデアではある

[ymorimo]

エラーにはコードを振らないと気が済まない人、たくさんいそう

[oooooooo]

エラーコードの再発明

[hiby]

宗教論争に発展。

[ustar]

ぐるなびAPIの設計

[ag-commerce]

なぜエラーコードの再発明は駄目なのでしょうか。それは専用のクライアントが必要になるからです。単なる HTTP クライアントではなく、ぐるなびのエラーコードを実装した専用クライアントが必要になってしまうからです

[rhosoi]

つーかさ、フツーのwebページで言える。「削除されました」とか「見つかりませんでした」ってのは、200じゃなく

[ultraist]

HTTPの上に定義している別プロトコルのようだからHTTPのステータスコードは関係ないのでは。HTTPのエラーが原因でTCPレベルのRSTを送ったりしないでしょ。HTTPで400ではないパラメータエラーで400を返すほうがおかしいのでは

[FOCKER]

api 設計

[raitu]

ぐるなびAPIのHTTP Status Codeがなんか変だという話

[send]

すばらしい

[sampaguita]

"もし、この二つを区別する理由が、エラーメッセージを出すためだけであれば、メッセージそのものをプレーンテキストで返せばいいのです"

[convivial]

ごもっとも

[nsta]

ぐるなびAPIを例にした『悪例』／エラーメッセージはプレインテキストで

[kmachu]

SOAPなんかも再発明しちゃってるんだよね。欲張りすぎたか。

[nilab]

yohei-y:weblog: HTTP ステータスコードを正しく使おう : 「なぜエラーコードの再発明は駄目なのでしょうか。それは専用のクライアントが必要になるからです。」Internal Server Error も XML で返したい意図があったのかも

[n2s]

とりあえす関連？する話題を。つhttp://neta.ywcafe.net/000552.html

[lockcole]

ぐるなびAPIが，せっかくある標準のステータスコードを使わず，オレオレエラーコードを再発明している件について。マッピングの例を見ると，わざわざ作るほどのもんではない。コードは統一してbodyで表現するべき？

[hisasann]

賢い人発見

[kdaiba]

なるほど

[hiro_y]

APIのレスポンスとしてHTTPのステータスを上手に使う。

[todogzm]

HTTPのステータスとして返すべきか、独自にエラーを作るべきか、どちらにすればいいのか判断に困る…。

[tkawa]

そのとおりです

[samurai20000]

ぐるなびAPIがエラーコードを自前で実装して良くないらしい。