in-house-swagger / in-house-swagger

in-house swagger-tools server

Home Page:https://in-house-swagger.github.io/in-house-swagger/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

editorで通知するエラーを利用者向けにしたい

suwa-sh opened this issue · comments

ストーリー

利用者 として
Spec管理で発生したエラーを把握するために、
操作と紐付けたメッセージを確認できる。

背景・経緯

現状の spec-mgrから返されたエラーメッセージは
spec-mgrとしての操作に紐付いたメッセージになっている。
※重複した specId を POST すると「すでにディレクトリが存在する」など

このまま、画面に表示しても利用者としてはわからないので
「すでにSpecが存在する」などにマッピングしたい。

受け入れ条件

  1. editorで通知されるエラーメッセージが、利用者から理解できること

対応詳細

  1. spec-mgr側で、webapi responseにmessageCodeを追加
{
  payload: {}
  _errors: {
    empty: false
    list: [
      {
        propertyKey: Specification
        code: dir.alreadyExist
        message: ディレクトリが既に存在します。対象ディレクトリ:...
    ]
  }
}
  1. spec-mgr側で、DELETEのerror発生時にresponse bodyを返すように変更
    現状は、DELETEのレスポンスボディはないので、エラー時も400系が返されるだけなので。
  2. editor側で、messageCodeから、自分のメッセージマッピングする処理を追加
  3. in-house-swaggerで、更新版を取り込み

一旦、spec-mgr側のメッセージを整備した。
データ不整合な状況の場合、unexpectedErrorが発生するはずなので
このメッセージ置換は検討したほうが良いかも。