跳到主要内容

工具

DeepSeek V3 中英对照 Tools

HAL 资源管理器​

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>
xml

以下代码展示了如何在 Gradle 中添加依赖：

dependencies {
    implementation 'org.springframework.data:spring-data-rest-hal-explorer'
}
groovy
备注

如果你使用 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!，变量基本上会被忽略。对于像 Projections and Excerpts 或 Paging and Sorting 这样的情况，这可能是有用的。

当你点击带有 + 或 > 符号的 NON-GET 按钮时，会弹出一个模态对话框。它显示与所点击按钮关联的 HTTP 方法。你可以填写请求体并提交新的 JSON 文档。

在 URI 和 HTTP 方法下方是字段。这些字段会根据资源的元数据自动提供，而这些元数据是由 Spring Data REST 自动生成的。如果你更新了领域对象，弹出窗口也会相应地反映这些变化，如下图所示：

hal explorer 2