Skip to content
ADP
API Design PrincipleBETA

[ADP-705] 名稱欄位慣例

指導原則

  • 如果可能存在歧義或衝突,可以(MAY)在 name 欄位前加上 ${資源類型} 前綴。

設計理由

name 欄位通常是資源物件中的常見屬性。在其前面加上資源類型可以明確說明該欄位是指資源本身的名稱還是其他內容。

範例

json
{
  "principleName": "我的原則"
}