WebAPI作りで最低限押さえておいたほうが良いと思ったこと | DevelopersIO
はじめに おばんです、人生初健保鮨行きが決定して楽しみな田中です。? このエントリでは、私がここ最近WebAPIを作っていてクライアントサイドとのやりとりを通して学んだ、「話して決めておいたほうがよいこと」をまとめます。出てくるコード例はNode.jsで書いています。 エラーはわかりやすく、管理しやすく エラーが発生したとき、HTTPステータスコードだけで原因を区別するのが難しい場合があります。エラーをわかりやすく、管理しやすくするためには そのエラーが「なんなのか」、「なぜ発生したのか」、「次にどうすべきなのか」 を明記し、デバッグや管理のための 手間を減らす 必要があります。 今回、例として取り扱うのが以下のjsonです。これはリクエストボディに含んだエラーを示しています。このエラーのなにが良いかを解説していきます。 { "error": "LackOfLoginParameter",
サーバサイドエンジニアが考える、エラー発生時のより良いUX
誰のためのエラーメッセージなのか意識する 私はサーバサイドエンジニアとして API を提供する立場なので、サーバ起因のエラーが起きたときに適切な情報を伝えるために何ができるかを考えてみます。 サーバサイドの視点では、クライアント（顧客）は２者存在すると考えることができます。 ひとつは、もちろんアプリケーションを実際に利用するエンドユーザ。 もうひとつは、サーバサイドが提供する API を利用するクライアントサイドエンジニア。 同じ事象でも対象によって伝えるべきエラーメッセージは変わってきます。 たとえば、エンドユーザにデータベースのエラーコードをそのまま伝えても不親切です。逆にクライアントサイドエンジニアに「不正なリクエストです」としか伝えなかった場合、何がどう不正なのか分からず、原因を切り分けるためにより詳しい情報を知りたいと思うでしょう。 つまり、それぞれの立場にたって「何の情報を伝え
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
