REST API中用於驗證的媒體類型

Question

我必須編寫Rest API才能對稱為Employee的對象執行CRUD操作。

class Employee {

   String name;

   String id;

}

-可以有更多字段，出於示例目的，我們僅考慮2。

在創建和更新時，可能會有很多驗證，例如

• 員工姓名和ID不能為空。

• 名稱不能超過40個字符。

• id只有字母。

在創建時，對於每次驗證，我都必須向用戶提供正確的消息。 如果一次創建操作有多個失敗。 我必須向用戶顯示所有消息。

我正在為此尋找一個好的設計解決方案。

Answer 1

由於您要求設計，因此我不會花時間向其中添加代碼，但是這個主意應該是這樣的：

• 制作一個可以保存錯誤的數據結構。 最好是一個用於存儲鍵值對的HashMap
• 對於要驗證的每個參數，請進行必要的檢查。 如果還好，一切都很好。 如果在某種程度上是錯誤的，請向HashMap添加一個條目來描述錯誤。
• 驗證之后，檢查HashMap是否具有任何條目。 如果是這樣，則有錯誤，您不應創建用戶，而應返回錯誤響應。 如果不是，那么您可以創建用戶並返回成功響應。

數據結構可能看起來像這樣（在JSON中）

{
    "success": "no",
    "error": "validation_failed",
    "validation_errors": [
        {"name": "too long"},
        {"id": "invalid format, must be String"}
    ]
}