跳到主要内容
版本:5.1.1

工具

Doubao 中英对照 Tools

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(物料清单),则无需指定版本。

当您在浏览器中访问应用的根 URI 时,该依赖会自动配置并提供 HAL Explorer。(注意:在浏览器中输入 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