工具

HAL Explorer

Kai Tödter 创建了一个有用的应用程序：HAL Explorer（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 Explorer，以便在浏览器中访问应用程序的根 URI 时提供服务。（注意：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 方法下方是字段。这些字段会根据资源的元数据自动提供，而该元数据是由 Spring Data REST 自动生成的。如果您更新您的域对象，弹出窗口会反映它，如下图所示

hal explorer 2