Skip to content
ADP
API Design PrincipleBETA

[ADP-320] 陣列慣例

指導原則

空陣列

  • 不得(MUST NOT)使用 null 表示空陣列。
  • 如果沒有資料提供,陣列應該(SHOULD)為空 ([]),而不是 null。

範例:

json
{
  "entries": []
}

不要使用:

json
{
  "entries": null
}

陣列一致性

  • 必須在 API 回應中維持一致的陣列結構。
  • 應該在不同端點中使用相同的欄位名稱和資料類型作為陣列元素。

陣列限制

  • 應該定義並記錄最大陣列大小,以防止效能問題。
  • 可以為大型陣列實施分頁(參見 ADP-312: 分頁)。

陣列排序

  • 應該維持一致的預設陣列元素排序。
  • 可以提供陣列的排序選項(參見 ADP-313: 排序)。

相關 ADP

參考資料