工具

HAL 资源管理器

Kai Tödter 创建了一个有用的应用程序：HAL 资源管理器（Git 代码库，参考文档，演示）。这是一个基于 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（物料清单），则无需指定版本。

此依赖项会自动配置 HAL 资源管理器，以便在您在浏览器中访问应用程序的根 URI 时提供服务。（注意：localhost:8080/api 已插入浏览器，它重定向到以下图像中显示的 URL。）

hal explorer 1

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

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

HAL 资源管理器理解 **URI 模板**。每当链接包含 URI 模板时，都会弹出一个模式对话框，您可以在其中输入模板参数。

hal explorer 3

如果您不输入任何内容就单击 **Go!**，则变量基本上会被忽略。对于 投影和摘录 或 分页和排序 等情况，这可能很有用。

当您单击带有“+”或“>”符号的 **非 GET** 按钮时，会显示一个模式对话框。它显示属于已单击按钮的 HTTP 方法。您可以填写正文并提交新的 JSON 文档。

URI 和 HTTP 方法下是字段。这些字段会根据资源的元数据自动提供，这些元数据是由 Spring Data REST 自动生成的。如果您更新域对象，则弹出窗口会反映出来，如下面的图像所示

hal explorer 2