content 和巢狀父級資訊,回應可能較大。
介面概覽
查詢參數
目前列表介面不支援
alias 或 parent_id 篩選。已知 alias 時直接呼叫文件詳情;建構樹狀導覽時一次分頁擷取後,使用每項 parent.id 在用戶端分組。
請求範例
回應結構
DocumentIndexSerializer,目前會回傳模型欄位及巢狀關係;關聯 API 文件還可能帶有 api_method。欄位可能會向後相容地增加,用戶端應按需讀取。需要 children、解析後的內容語言和內容雜湊時,使用詳情介面。
對於關聯來源文件的公開記錄,content_source 提供來源文件識別碼、來源內容雜湊、所請求的語言、翻譯更新時間及 ready、stale、missing、missing_source 或 ambiguous 狀態;其他記錄該欄位為 null。ready 時的 content_hash 對應該語言譯文。正文仍依原有規則顯示,包括缺少譯文時的語言回退;需要同步文件的用戶端應同時檢查狀態和雜湊,不能僅憑正文非空判斷已更新。
使用建議
- 回應包含正文,批次同步時使用分頁並設定合理逾時,不要並行擷取同一頁。
- alias 是公開頁面 URL 的穩定識別碼;已知 alias 時直接請求
/api/v1/documents/{alias}。 - 目前介面無法按父級進行伺服器端篩選;建構導覽時在用戶端按
parent.id分組。

