工具

HAL 资源浏览器

Kai Tödter 开发了一个实用的应用程序：HAL Explorer（Git 仓库，参考文档，演示）。这是一个基于 Angular 的 Web 应用程序，可让你轻松探索基于 HAL 和 HAL-FORMS 的 HTTP 响应。它还支持由 Spring Data REST 生成的 Spring 配置文件（profiles）。你可以将其指向任意 Spring Data REST API，并使用它来浏览应用以及创建新资源。spring-doc.cadn.net.cn

无需下载这些文件、将其嵌入到您的应用程序中，再编写一个 Spring MVC 控制器来提供它们，您只需添加一个依赖项即可。spring-doc.cadn.net.cn

以下清单展示了如何在 Maven 中添加该依赖项：spring-doc.cadn.net.cn

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

以下清单展示了如何在 Gradle 中添加该依赖项：spring-doc.cadn.net.cn

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

该依赖会自动配置 HAL Explorer，当你在浏览器中访问应用程序的根 URI 时，将自动提供 HAL Explorer 页面。（注意：localhost:8080/api 已被输入到浏览器中，并重定向到下图所示的 URL。）spring-doc.cadn.net.cn

hal explorer 1

上图显示了 API 的根路径。右侧是响应的详细信息，包括响应头和响应体（一个 HAL 文档）。spring-doc.cadn.net.cn

HAL Explorer 会从响应中读取链接，并将它们显示在左侧的列表中。您可以点击绿色的GET按钮导航到某个集合，也可以点击其他按钮来修改资源（POST、PUT、PATCH）或删除资源。spring-doc.cadn.net.cn

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

hal explorer 3

如果你在未输入任何内容的情况下点击Go!，这些变量基本上会被忽略。在投影与摘录或分页与排序等场景中，这可能会很有用。spring-doc.cadn.net.cn

当你点击一个带有 + 或 > 符号的非 GET按钮时，会弹出一个模态对话框。该对话框会显示与所点击按钮对应的 HTTP 方法。你可以填写请求体并提交新的 JSON 文档。spring-doc.cadn.net.cn

在 URI 和 HTTP 方法下方是各个字段。这些字段会根据资源的元数据自动提供，而元数据是由 Spring Data REST 自动生成的。如果你更新了你的领域对象，弹出窗口会随之反映这些更改，如下图所示：spring-doc.cadn.net.cn

hal explorer 2