工具

The HAL Explorer

Kai Tödter 创建了一个有用的应用程序：HAL Explorer（Git Repo、参考文档、演示）。它是一个基于 Angular 的 Web 应用程序，可让您轻松探索基于 HAL 和 HAL-FORMS 的 HTTP 响应。它还支持由 Spring Data REST 生成的 Spring 配置文件。您可以将其指向任何 Spring Data REST API，并使用它来导航应用程序和创建新资源。spring-doc.cn

无需拉取文件，将它们嵌入到应用程序中，并制作一个 Spring MVC 控制器来为它们提供服务，您需要做的就是添加一个依赖项。spring-doc.cn

下面的清单显示了如何在 Maven 中添加依赖项：spring-doc.cn

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

下面的清单显示了如何在 Gradle 中添加依赖项：spring-doc.cn

dependencies {
    implementation 'org.springframework.data:spring-data-rest-hal-explorer'
}
如果使用 Spring Boot 或 Spring Data BOM（物料清单），则无需指定版本。

此依赖项会自动将 HAL Explorer 配置为当您在浏览器中访问应用程序的根 URI 时提供服务。（注意：localhost：8080/api 已插入浏览器，并重定向到下图所示的 URL。spring-doc.cn

HAL Explorer 1 （HAL 浏览器 1）

前面的屏幕截图显示了 API 的根路径。右侧是响应中的详细信息，包括标头和正文（HAL 文档）。spring-doc.cn

HAL Explorer 从响应中读取链接，并将它们放在左侧的列表中。您可以单击绿色的 GET 按钮并导航到其中一个集合，也可以单击其他按钮进行更改（POST、PUT、PATCH）或删除资源。spring-doc.cn

HAL Explorer 可以识别 URI 模板。每当链接包含 URI 模板时，都会弹出一个模式对话框，您可以在其中输入模板参数。spring-doc.cn

HAL Explorer 3 （哈尔浏览器 3）

如果单击 Go！而不输入任何内容，则基本上会忽略这些变量。对于 Projections and Excerpts 或 Paging and Sorting 等情况，这可能很有用。spring-doc.cn

当您单击带有 或 号的 NON-GET 按钮时，将显示一个模态对话框。它显示属于单击按钮的 HTTP 方法。您可以填写正文并提交新的 JSON 文档。+>spring-doc.cn

URI 和 HTTP 方法下方是字段。这些是自动提供的，具体取决于资源的元数据，该元数据是由 Spring Data REST 自动生成的。如果更新域对象，弹出窗口将反映它，如下图所示：spring-doc.cn

HAL Explorer 2 （HAL 浏览器 2）