对于最新的稳定版本,请使用 Spring Data REST 4.3.1! |
对于最新的稳定版本,请使用 Spring Data REST 4.3.1! |
HAL 浏览器
Kai Tödter 创建了一个有用的应用程序:HAL Explorer(Git Repo、Reference Doc、Demo)。它是一个基于 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(物料清单),则无需指定版本。 |
此依赖项会自动将 HAL 资源管理器配置为在浏览器中访问应用程序的根 URI 时提供。(注意:localhost:8080/api 已插入浏览器,并重定向到下图所示的 URL。
前面的屏幕截图显示了 API 的根路径。右侧是响应的详细信息,包括标题和正文(HAL 文档)。
HAL 资源管理器从响应中读取链接,并将它们放在左侧的列表中。您可以单击绿色的 GET 按钮并导航到其中一个集合,也可以单击其他按钮进行更改(POST、PUT、PATCH)或删除资源。
HAL 资源管理器了解 URI 模板。每当链接包含 URI 模板时,都会弹出一个模式对话框,您可以在其中输入模板参数。
当您单击带有 或 Sign 的 NON-GET 按钮时,会出现一个模式对话框。它显示属于单击按钮的 HTTP 方法。您可以填写正文并提交新的 JSON 文档。+
>
URI 和 HTTP 方法下方是字段。这些是自动提供的,具体取决于资源的元数据,这些元数据是由Spring Data REST自动生成的。如果更新域对象,弹出窗口会反映它,如下图所示:
如果使用 Spring Boot 或 Spring Data BOM(物料清单),则无需指定版本。 |