はじめに

JSON ハイパー・スキーマは、ハイパーメディア駆動型APIの定義を可能にするJSON スキーマの拡張です。ハイパー・スキーマの語彙は、JSON データ上で実行できるリンクやアクションの説明を可能にすることで、ハイパーメディアコントロールを使用して JSON ドキュメントに注釈を付ける方法を示しています。これにより、JSON データのよりインタラクティブで動的な表現を提供するのに役立ちます。また、JSON ドキュメント内のアクションとリンクの説明機能を使用して、API の検出可能性も向上させます。

JSON ハイパー・スキーマは既存の JSON HTTP API とシームレスに統合し、複雑なリソース関係を記述し、クライアント側の検証を容易にし、より優れたインタラクションパターンを促進する機能を提供します。特に RESTful アーキテクチャにおいて、API をより直感的で自己記述的で効率的にします。

要約すると

• JSON ハイパー・スキーマは、クライアントがリソースとアクション間の関係を定義して明示的に理解する必要がある複雑な API に役立ちます。特に、API の構造を事前に知らずにリソースをナビゲートする場合に役立ちます。
• より検出可能で自己文書化された API を作成するのに役立ち、クライアントが API とより簡単にやり取りできるようにします。

ハイパー・スキーマ仕様

• ハイパー・スキーマ：draft-handrews-json-schema-hyperschema-02
• 相対JSONポインタ：draft-bhutton-relative-json-pointer-00

スキーマ

• JSON ハイパー・スキーマ メタスキーマ
• JSON ハイパー・スキーマ 語彙スキーマ
• JSON ハイパー・スキーマ リンク記述オブジェクト メタスキーマ
• JSON スキーマ出力スキーマと例

リリースノート

• Draft-07 から 2019-09 へ
• Draft-04 から Draft-07 へ
• Draft-04 から Draft-06 へ