註解

JSON Schema 包含一些關鍵字，這些關鍵字不嚴格用於驗證，而是用於描述綱要的各個部分。這些「註解」關鍵字都不是必要的，但為了良好的實踐，建議使用它們，而且可以使您的綱要「自我說明」。

註解關鍵字可以用於任何綱要或子綱要。像其他關鍵字一樣，它們可能只能使用一次。

title 和 description 關鍵字必須是字串。「title」最好簡短，而「description」將提供更詳細的說明，說明綱要所描述的資料的用途。

default 關鍵字指定預設值。此值不用於在驗證過程中填入遺失的值。諸如文件產生器或表單產生器之類的非驗證工具可能會使用此值來向使用者提示如何使用值。但是，default 通常用於表示如果遺失值，則該值在語義上與存在預設值時相同。default 的值應根據其所在的綱要進行驗證，但這不是必需的。

draft 6 新增

examples 關鍵字用於提供一個範例陣列，這些範例根據綱要進行驗證。這不用於驗證，但可能有助於向讀者解釋綱要的作用和目的。每個條目都應根據其所在的綱要進行驗證，但這不是嚴格要求的。沒有必要在 examples 陣列中複製 default 值，因為 default 將被視為另一個範例。

draft 7 新增

布林值關鍵字 readOnly 和 writeOnly 通常在 API 環境中使用。readOnly 指示不應修改值。它可以用於指示更改值的 PUT 請求將導致 400 Bad Request 回應。writeOnly 指示可以設定值，但將保持隱藏狀態。它可以用於指示您可以使用 PUT 請求設定值，但在使用 GET 請求檢索該記錄時不會包含該值。

draft 2019-09 新增

deprecated 關鍵字是一個布林值，指示不應使用關鍵字所套用的實例值，並且將來可能會被移除。

schema

{ "title": "符合任何內容", "description": "這是一個符合任何內容的綱要。", "default": "預設值", "examples": [ "任何內容", 4035 ], "deprecated": true, "readOnly": true, "writeOnly": false}