对于最新的稳定版本,请使用 Spring Data REST 4.5.3spring-doc.cadn.net.cn

工具

HAL 浏览器

Kai Tödter 创建了一个有用的应用程序:HAL Explorer(Git 存储库参考文档演示)。它是一个基于 Angular 的 Web 应用程序,可让您轻松探索基于 HAL 和 HAL-FORMS 的 HTTP 响应。它还支持 Spring Data REST 生成的 Spring 配置文件。您可以将其指向任何 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 资源管理器,以便在您在浏览器中访问应用的根 URI 时提供。(注意:localhost:8080/api 已插入浏览器,并重定向到下图所示的 URL。spring-doc.cadn.net.cn

HAL 探索者 1

前面的屏幕截图显示了 API 的根路径。右侧是响应中的详细信息,包括标头和正文(HAL 文档)。spring-doc.cadn.net.cn

HAL 资源管理器会从响应中读取链接,并将它们放在左侧的列表中。您可以单击绿色的 GET 按钮并导航到其中一个集合,也可以单击其他按钮进行更改(POST、PUT、PATCH)或删除资源。spring-doc.cadn.net.cn

HAL 资源管理器可以理解 URI 模板。每当链接包含 URI 模板时,都会弹出一个模式对话框,您可以在其中输入模板参数。spring-doc.cadn.net.cn

HAL 探索者 3

如果单击“开始!”而不输入任何内容,则基本上将忽略这些变量。对于投影和摘录分页和排序等情况,这可能很有用。spring-doc.cadn.net.cn

当您单击带有 或 符号的 NON-GET 按钮时,将出现一个模式对话框。它显示了属于单击的按钮的 HTTP 方法。您可以填写正文并提交新的 JSON 文档。+>spring-doc.cadn.net.cn

URI 和 HTTP 方法下方是字段。这些是自动提供的,具体取决于资源的元数据,这些元数据是由 Spring Data REST 自动生成的。如果更新域对象,弹出窗口会反映它,如下图所示:spring-doc.cadn.net.cn

HAL 探索者 2