工具

HAL Explorer

Kai Tödter 建立了一個有用的應用程式：HAL Explorer（Git Repo、參考文件、演示）。這是一個基於 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 Explorer 以供使用。（注意：localhost:8080/api 已插入瀏覽器，並重定向到下圖中顯示的 URL。）

前面的螢幕截圖顯示了 API 的根路徑。右側是響應的詳細資訊，包括標頭和正文（HAL 文件）。

HAL Explorer 從響應中讀取連結，並將其放在左側的列表中。您可以單擊綠色的 GET 按鈕導航到其中一個集合，也可以單擊其他按鈕進行更改（POST、PUT、PATCH）或刪除資源。

HAL Explorer 理解 URI 模板。每當連結包含 URI 模板時，都會彈出一個模式對話方塊，您可以在其中輸入模板引數。

如果您在未輸入任何內容的情況下單擊 Go!，則變數基本上會被忽略。對於像投影和摘錄或分頁和排序這樣的情況，這會很有用。

當您單擊帶有 + 或 > 符號的 NON-GET 按鈕時，會彈出一個模式對話方塊。它顯示了屬於所單擊按鈕的 HTTP 方法。您可以填充正文並提交新的 JSON 文件。

URI 和 HTTP 方法下方是欄位。這些欄位是根據資源的元資料自動提供的，而這些元資料是由 Spring Data REST 自動生成的。如果您更新域物件，彈出視窗會反映出來，如下圖所示