ツール

HAL エクスプローラー

KaiT ö dter は便利なアプリケーションを作成しました: HAL Explorer（Git リポジトリ [GitHub] (英語) 、リファレンスドキュメント (英語) 、デモ (英語) ）。これは Angular ベースの Web アプリケーションであり、HAL および HAL-FORMS ベースの HTTP レスポンスを簡単に調べることができます。また、Spring Data REST によって生成された Spring プロファイルもサポートします。任意の Spring Data REST API にポイントし、それを使用してアプリをナビゲートし、新しいリソースを作成できます。

ファイルをプルダウンしてアプリケーションに埋め込み、Spring MVC コントローラーを作成して提供する代わりに、必要なことは単一の依存関係を追加することだけです。

次のリストは、Maven に依存関係を追加する方法を示しています。

<dependencies>
  <dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-rest-hal-explorer</artifactId>
  </dependency>
</dependencies>

次のリストは、Gradle に依存関係を追加する方法を示しています。

dependencies {
    implementation 'org.springframework.data:spring-data-rest-hal-explorer'
}
Spring Boot または Spring Data BOM（部品表）を使用する場合は、バージョンを指定する必要はありません。

この依存関係により、ブラウザーでアプリケーションのルート URI にアクセスしたときに提供される HAL エクスプローラーが自動構成されます。(NOTE: localhost:8080/api はブラウザーに接続され、次のイメージに示す URL にリダイレクトされました。)

hal explorer 1

前のスクリーンショットは、API のルートパスを示しています。右側には、ヘッダーを含むレスポンスの詳細と本文（HAL ドキュメント）があります。

HAL Explorer は、レスポンスからリンクを読み取り、左側のリストに配置します。緑色の GET ボタンをクリックしてコレクションの 1 つに移動するか、他のボタンをクリックして変更（POST、PUT、PATCH）を行うか、リソースを削除することができます。

HALExplorer は URI テンプレートを理解します。リンクに URI テンプレートが含まれている場合は常に、テンプレートパラメーターを入力できるモーダルダイアログがポップアップ表示されます。

hal explorer 3

何も入力せずに実行 ! をクリックすると、変数は基本的に無視されます。射影と抜粋やページングとソートのような状況では、これが役立ちます。

+ または > サインが付いた NON-GET ボタンをクリックすると、モーダルダイアログが表示されます。クリックされたボタンに属する HTTP メソッドを示しています。本文に入力して、新しい JSON ドキュメントを送信できます。

URI と HTTP メソッドにフィールドがあります。これらは、Spring Data REST によって自動的に生成されたリソースのメタデータに応じて、自動的に提供されます。次のイメージに示すように、ドメインオブジェクトを更新すると、ポップアップにそれが反映されます。

hal explorer 2