ランサーズ等のサービスを開発・運用する中で得た知識やノウハウを紹介しています。

thumbnail

Labels:  DevOps 投稿者:mori-dev

ぼくの考えた最強の WebAPI のエラーレスポンス型(仮)の mson を発表します!!1

です。
昨日、API仕様を考えていて、社内チャットで雑談した成果になります。ご査収下さい。

 

## Error

+ status_code: `500` (number, required) – ステータスコード
+ type: `validation_error` (string, required) – エラー種別。プログラムからの利用を想定
+ logged_at `2014-10-10T13:50:40+09:00` (string, required) – エラー発生時刻。 `yyyy-MM-ddTHH:mm:ss` 形式。調査用
+ message: `validation_error_foo_bar` (string, optional) – エラーの詳細な説明
+ user_message_title: `入力内容が不正です` (string, optional) – ユーザに直接表示できるエラーのタイトル
+ user_messages: `XXXを入力してください` (array, optional) – ユーザに直接表示できるエラーの説明文の配列
+ tip: `ああするとよいかもしれません` (string, optional) – どう対処したらいいかの説明

  • logged_at はサーバーのログ出力形式と合わせる
  • 人間用のメッセージなのか、コード用のメッセージなのか明示した
  • レスポンスボディでステータスコードなどいらん、と思ってたけど改心した
  • user_messages を配列とすることで、たとえばバリデーションエラーなんかを一括してレスポンスできる

参考ページ

関連記事

thumbnail
dotsで登壇してきました

CTOの横井です。 こないだの7/31にdotsさんで、下記のイベントに登壇してきました。 http://eventdots.jp/event/593939 当日は、アクトキャットさん、BECさん、サイバーエージェントさんと、ランサーズの4社で普段のプロジェク …

thumbnail
React.js/redux アプリでの Google Analytics のイベントトラッキングの設定

森です。 React.js/redux アプリでの Google Analytics のイベントトラッキング用の設定を紹介します。 ライブラリ 以下のライブラリを用います。 analyticsjs eventTracker(autotrack plugin) …

事業の多角化を支えたランサーズ的SRE術
事業の多角化を支えたランサーズ的SRE術 | TECH PLAY 勉強会

こんにちは、ランサーズでSREチームのエンジニア(内定者インターン)をしているIZUMIRUです。 今回は、2018年2月20日(火) 19:30-21:45に、TECH PLAY SHIBUYAで開催された ランサーズ株式会社主催の勉強会である『事業の多角化 …