工具

HAL Explorer

Kai Tödter 建立了一個實用的應用程式：HAL Explorer (Git Repo, Reference Doc, Demo)。它是一個基於 Angular 的 Web 應用程式，可讓您輕鬆探索基於 HAL 和 HAL-FORMS 的 HTTP 回應。它也支援 Spring Data REST 產生的 Spring Profile。您可以將其指向任何 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。)

hal explorer 1

上述螢幕截圖顯示 API 的根路徑。右側是回應的詳細資訊，包括標頭和主體（HAL 文件）。

HAL Explorer 從回應中讀取連結，並將它們放在左側的列表中。您可以點擊綠色的 **GET** 按鈕並導航到其中一個集合，或點擊其他按鈕進行變更 (POST、PUT、PATCH) 或刪除資源。

HAL Explorer 理解 URI 模板。每當連結包含 URI 模板時，就會彈出一個模態對話框，您可以在其中輸入模板參數。

hal explorer 3

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

當您點擊帶有 + 或 > 符號的 **NON-GET** 按鈕時，會出現一個模態對話框。它顯示屬於點擊按鈕的 HTTP 方法。您可以填寫主體並提交新的 JSON 文件。

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

hal explorer 2