Skip to content
ADP
API Design PrincipleBETA

[ADP-150] 軟刪除(Soft Deletion)

  • 在特定情況下,應該(SHOULD)考慮實作 API 層面的軟刪除機制,讓使用者能夠獲取被刪除資源的信息,並提供刪除恢復的選擇。
  • 已經被軟刪除的資源不應該(SHOULD NOT)出現在相關的集合列表中,除非另外設計有專門的 API 用於顯示這些資源。比如: /deleted-resources
  • 應該(SHOULD)設計機制,以便在特定時間後刪除已經被標記為軟刪除的資源。
  • 可以(MAY)考慮實作刪除恢復的 API,讓使用者能夠恢復已經被刪除的資源。
    • DRAFT 刪除操作應該(SHOULD)一律使用 DELETE 方法,而恢復刪除操作則沒有通用的規範。為了統一性和可讀性,建議使用 POST /deleted-resources/${id}/recover 方法進行恢復操作。

參考