端點行為補充
單一 API 端點在欄位定義之外的行為說明:可見範圍、事件語意、排序規則與相容性變更。
每支端點的欄位契約(路徑、參數、請求與回應欄位、型別、必填)以 API 文件 為準。這一節只寫 schema 表達不出來的行為,例如:
可見範圍:同一支端點,不同身分的呼叫者看得到哪些資料。
事件語意:即時事件何時送出、代表什麼、收到後該怎麼處理。
排序規則:清單依什麼順序回傳,整合端能不能自行重排。
相容性變更:會讓既有串接失效的變更,以及要怎麼調整。
本節頁面
頁面
補充的行為
可見範圍、到期時間的計算方式
可見範圍、讀取來源、排序與過濾規則、回應欄位
可見範圍、即時事件與未讀數
組織範圍、記憶狀態
依網域決定品牌、空值處理、回應欄位
排序規則
欄位值對照、組合限制、回應形狀
回應欄位、篩選參數、彙總做法
相容性變更
最後更新於
這有幫助嗎?