ヘイトアス

アプリケーション状態のエンジンとしてのハイパーメディア( HATEOAS ) は、REST ソフトウェア アーキテクチャ スタイルの制約であり、他のネットワークアーキテクチャ スタイルと区別されます。

HATEOAS を使用すると、クライアントは、ハイパーメディアを通じて動的に情報を提供するアプリケーション サーバーを備えたネットワーク アプリケーションと対話します。REST クライアントは、ハイパーメディアの一般的な理解以外に、アプリケーションまたはサーバーと対話する方法に関する事前の知識をほとんど必要としません。

対照的に、Common Object Request Broker Architecture (CORBA) のクライアントとサーバーは、ドキュメントまたはインターフェース記述言語(IDL) を通じて共有される固定インターフェースを介して対話します。

HATEOAS によって課せられる制限により、クライアントとサーバーが分離されます。これにより、サーバーの機能が独立して進化できるようになります。

この用語は2000年にロイ・フィールディングが博士論文の中で作った造語である。^[1]

ユーザーエージェントは、エントリポイントURLを通じて REST API に HTTP リクエストを送信します。ユーザーエージェントが送信する以降のすべてのリクエストは、各リクエストに対する応答内で検出されます。これらの表現に使用されるメディアタイプと、それらに含まれるリンク関係は、API の一部です。クライアントは、表現内のリンクを選択するか、メディアタイプによって提供される他の方法で表現を操作することで、アプリケーションの状態を遷移します。このように、RESTful なインタラクションは、帯域外情報ではなくハイパーメディアによって駆動されます。^[2]

例えば、このGETリクエストはアカウントリソースを取得し、JSON表現で詳細を要求します: ^[3]

GET  /accounts/12345  HTTP / 1.1
ホスト:  bank.example.com

応答は次のとおりです。

HTTP / 1.1  200  OK

{
    "アカウント"： {
        「アカウント番号」: 12345,
        "バランス"： {
            "通貨": "米ドル",
            「値」: 100.00
        },
        「リンク」: {
            「預金」: 「/accounts/12345/deposits」、
            「引き出し」: 「/accounts/12345/引き出し」、
            「転送」: 「/accounts/12345/転送」、
            「クローズリクエスト」: 「/accounts/12345/クローズリクエスト」
        }
    }
}

応答には、次のフォローアップ リンクが含まれます: 入金、出金、送金、または閉鎖リクエスト (アカウントを閉鎖する) を POST します。

たとえば、後で口座残高が不足すると、口座残高が不足しているため、利用可能なリンクのセットが異なります。

HTTP / 1.1  200  OK

{
    "アカウント"： {
        「アカウント番号」: 12345,
        "バランス"： {
            "通貨": "米ドル",
            「値」: -25.00
        },
        「リンク」: {
            「預金」: 「/accounts/12345/預金」
        }
    }
}

現在、利用できるリンクは 1 つだけです。それは、お金をさらに入金することです (deposits に POST することによって)。現在の状態では、他のリンクは使用できません。そのため、アプリケーション状態のエンジンと呼ばれます。実行可能なアクションは、リソースの状態に応じて異なります。

クライアントは、サーバーが提供するすべてのメディアタイプと通信メカニズムを理解する必要はありません。新しいメディアタイプを理解する能力は、サーバーがクライアントに提供する「オンデマンドコード」を通じて実行時に獲得できます。^[1]

HATEOAS制約は、 Roy Fieldingの博士論文で定義されているように、RESTの「統一インターフェース」機能の重要な部分です。 ^[1] Fieldingはブログでこの概念をさらに詳しく説明しています。^[2]

Fielding は、この制約やその他の REST 制約の厳しさの目的について、「数十年規模のソフトウェア設計: すべての詳細がソフトウェアの寿命と独立した進化を促進することを目的としています。制約の多くは、短期的な効率に直接反するものです。残念ながら、人々は短期的な設計は得意ですが、長期的な設計は苦手です」と説明しています。^[2]

• HTML自体はハイパーメディアであり、<form>...</form>要素はリンクへのHTTPリクエストを制御します。^{[2] [4]} HtmxはHTMLに拡張機能を導入し、要素以外の要素がリクエストを制御できるようにし<form>...</form>ます<button>...</button>。
• HAL は、JSON または XML 上に構築されたハイパーメディアです。リンクは定義しますが、アクション (HTTP リクエスト) は定義しません。
• JSON-LD は、JSON 内のハイパーリンクの標準です。アクションについては扱いません。
• SirenはJSON上に構築されたハイパーメディアです。リンクとアクションを定義します。^[5]
• Collection+JSON、JSON上に構築されたハイパーメディア。リンクとアクションを定義します。^[6]
• JSON:APIはリンクとアクションを定義します。^[7]
• Hydra。JSON-LDの上に構築され、アクションの定義を追加します。^[8]

• htmlファイル
• ハイパーテキストアプリケーション言語
• ユニバーサル記述検出と統合は、Webサービス記述言語に相当する。