簡介

JSON Hyper-Schema 是 JSON Schema 的擴展，允許定義超媒體驅動的 API。超 schema 詞彙表展示了如何使用超媒體控制來註解 JSON 文件，透過描述可以在 JSON 資料上執行的連結和動作。隨後，它有助於提供更具互動性和動態的 JSON 資料表示。它還使用 JSON 文件中動作和連結的描述功能來增強 API 的可發現性。

JSON Hyper-Schema 無縫整合現有的 JSON HTTP API，並提供描述複雜資源關係、促進用戶端驗證以及推廣更好互動模式的功能。它使 API 更直觀、自我描述且高效，尤其是在 RESTful 架構中。

本質上

• JSON Hyper-Schema 在複雜的 API 中很有用，在這些 API 中，用戶端需要明確定義和理解資源和動作之間的關係，尤其是在瀏覽資源時，事先不知道 API 的結構。
• 它有助於建立更可發現和自我說明的文件化 API，使客戶端更容易與它們互動。

Hyper Schema 規範

• Hyper-Schema: draft-handrews-json-schema-hyperschema-02
• 相對 JSON 指標: draft-bhutton-relative-json-pointer-00

Schemas

• JSON Hyper-Schema meta-schema
• JSON Hyper-Schema 詞彙表 schema
• JSON Hyper-Schema 連結描述物件 meta-schema
• JSON Schema 輸出 schemas 和範例

版本資訊

• Draft-07 到 2019-09
• Draft-04 到 Draft-07
• Draft-04 到 Draft-06