工具

HAL Explorer

Kai Tödter 创建了一个有用的应用程序：HAL Explorer（Git Repo、参考文档、演示）。这是一个基于 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（材料清单），则无需指定版本。

当您在浏览器中访问应用程序的根 URI 时，此依赖项会自动配置 HAL Explorer 以供使用。（注意：localhost:8080/api 已插入浏览器，并重定向到下图中显示的 URL。）

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

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

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

如果您在未输入任何内容的情况下单击 Go!，则变量基本上会被忽略。对于像投影和摘录或分页和排序这样的情况，这会很有用。

当您单击带有 + 或 > 符号的 NON-GET 按钮时，会弹出一个模式对话框。它显示了属于所单击按钮的 HTTP 方法。您可以填充正文并提交新的 JSON 文档。

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