此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Data REST 4.4.0！spring-doc.cn

存储库资源

基础

Spring Data REST 的核心功能是导出 Spring Data 存储库的资源。因此，要查看并可能自定义导出工作方式的核心工件是 repository 接口。请考虑以下存储库接口：spring-doc.cn

public interface OrderRepository extends CrudRepository<Order, Long> { }

对于此存储库， Spring Data REST 在 中公开了集合资源。该路径派生自所管理的域类的未大写、复数、简单的类名。它还为 URI 模板下的存储库管理的每个项目公开一个项目资源 。/orders/orders/{id}spring-doc.cn

默认情况下，与这些资源交互的 HTTP 方法映射到相应的方法。在集合资源和项目资源部分阅读更多相关信息。CrudRepositoryspring-doc.cn

存储库方法公开

为特定存储库公开哪些 HTTP 资源主要由存储库的结构驱动。 换句话说，资源公开将遵循您在仓库中公开的方法。 如果你扩展，你通常会暴露暴露所有需要的方法，以暴露我们默认可以注册的所有 HTTP 资源。 下面列出的每个资源都将定义需要存在哪些方法，以便可以为每个资源公开特定的 HTTP 方法。 这意味着，未公开这些方法的存储库（无论是通过完全不声明它们还是显式使用）都不会在这些资源上公开这些 HTTP 方法。CrudRepository@RestResource(exported = false)spring-doc.cn

有关如何单独调整默认方法、公开或专用 HTTP 方法的详细信息，请参阅自定义支持的 HTTP 方法。spring-doc.cn

默认状态代码

对于公开的资源，我们使用一组默认状态代码：spring-doc.cn

  • 200 OK：用于普通请求。GETspring-doc.cn

  • 201 Created：对于创建新资源的 and 请求。POSTPUTspring-doc.cn

  • 204 No Content：对于、 和 请求，当配置设置为不返回资源更新的响应正文时 （） 。 如果将配置值设置为包含响应，则返回 的更新，并返回通过 创建的资源的响应。PUTPATCHDELETERepositoryRestConfiguration.setReturnBodyOnUpdate(…)PUT200 OK201 CreatedPUTspring-doc.cn

如果配置值 （ 和 ） 显式设置为 — 默认情况下，它们--,使用 HTTP Accept 标头的存在来确定响应代码。 在 collection 和 item 资源的详细说明中阅读更多相关信息。RepositoryRestConfiguration.returnBodyOnUpdate(…)RepositoryRestConfiguration.returnBodyCreate(…)nullspring-doc.cn

资源可发现性

HATEOAS 的一个核心原则是，应该通过发布指向可用资源的链接来发现资源。关于如何在 JSON 中表示链接，存在一些相互竞争的事实标准。默认情况下，Spring Data REST 使用 HAL 来呈现响应。HAL 定义要包含在返回文档的属性中的链接。spring-doc.cn

资源发现从应用程序的顶层开始。通过向部署 Spring Data REST 应用程序的根 URL 发出请求，客户端可以从返回的 JSON 对象中提取一组链接，这些链接表示客户端可用的下一级别资源。spring-doc.cn

例如，要发现应用程序根目录中可用的资源，请向根 URL 发出 HTTP，如下所示：GETspring-doc.cn

curl -v http://localhost:8080/

< HTTP/1.1 200 OK
< Content-Type: application/hal+json

{ "_links" : {
    "orders" : {
      "href" : "http://localhost:8080/orders"
    },
    "profile" : {
      "href" : "http://localhost:8080/api/alps"
    }
  }
}

结果文档的属性是一个对象，该对象由表示关系类型的键组成，其中包含 HAL 中指定的嵌套链接对象。spring-doc.cn

有关该链接的更多详细信息，请参阅应用程序级配置文件语义 （ALPS）。profile

集合资源

Spring Data REST 公开了一个集合资源，该集合资源以导出的存储库正在处理的域类的未大写复数版本命名。资源名称和路径都可以通过在存储库界面上使用来自定义。@RepositoryRestResourcespring-doc.cn

支持的 HTTP 方法

集合资源同时支持 和 。所有其他 HTTP 方法都会导致 .GETPOST405 Method Not Allowedspring-doc.cn

GET

通过其方法返回存储库服务器的所有实体。 如果存储库是分页存储库，我们会根据需要包含分页链接和其他页面元数据。findAll(…)spring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

参数

如果存储库具有分页功能，则资源采用以下参数：spring-doc.cn

  • page：要访问的页码（0 已编入索引，默认为 0）。spring-doc.cn

  • size：请求的页面大小（默认为 20）。spring-doc.cn

  • sort：格式为 ？.($propertyname,)+[asc|desc]spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：GETspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或存储库中不存在。findAll(…)@RestResource(exported = false)spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：GETspring-doc.cn

该方法支持用于发现相关资源的单个链接：GETspring-doc.cn

HEAD

该方法返回集合资源是否可用。它没有状态代码、媒体类型或相关资源。HEADspring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

POST

该方法从给定的请求正文创建新实体。 默认情况下，响应是否包含正文由随请求发送的标头控制。 如果发送了响应正文，则会创建一个响应正文。 否则，响应正文为空，可以通过响应标头中包含的以下链接获取所创建资源的表示形式。 可以通过相应地配置来覆盖此行为。POSTAcceptLocationRepositoryRestConfiguration.setReturnBodyOnCreate(…)spring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：POSTspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或根本不存在于存储库中。save(…)@RestResource(exported = false)spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：POSTspring-doc.cn

Item 资源

Spring Data REST 将单个集合项的资源公开为集合资源的子资源。spring-doc.cn

支持的 HTTP 方法

Item 资源通常支持 、 、 和 ，除非显式配置阻止（有关详细信息，请参阅“关联资源”）。GETPUTPATCHDELETEspring-doc.cn

获取

该方法返回单个实体。GETspring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：GETspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或存储库中不存在。findOne(…)@RestResource(exported = false)spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：GETspring-doc.cn

相关资源

对于域类型的每个关联，我们都会公开以 association 属性命名的链接。您可以通过对属性使用来自定义此行为。相关资源为 association 资源类型。@RestResourcespring-doc.cn

HEAD

该方法返回项资源是否可用。它没有状态代码、媒体类型或相关资源。HEADspring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

PUT

该方法将目标资源的状态替换为提供的请求正文。 默认情况下，响应是否包含正文由随请求发送的标头控制。 如果存在请求标头，则返回响应正文和状态代码。 如果不存在标头，则响应正文为空，并且成功的请求将返回状态 。 可以通过相应地配置来覆盖此行为。PUTAccept200 OK204 No ContentRepositoryRestConfiguration.setReturnBodyOnUpdate(…)spring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：PUTspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或根本不存在于存储库中。save(…)@RestResource(exported = false)spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：PUTspring-doc.cn

PATCH

该方法与该方法类似，但部分更新了资源状态。PATCHPUTspring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：PATCHspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或存储库中不存在。save(…)@RestResource(exported = false)spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：PATCHspring-doc.cn

DELETE

该方法删除公开的资源。 默认情况下，响应是否包含正文由随请求发送的标头控制。 如果存在请求标头，则返回响应正文和状态代码。 如果不存在标头，则响应正文为空，并且成功的请求将返回状态 。 可以通过相应地配置来覆盖此行为。DELETEAccept200 OK204 No ContentRepositoryRestConfiguration.setReturnBodyOnDelete(…)spring-doc.cn

用于调用的方法

如果存在，则使用以下方法（降序）：spring-doc.cn

有关方法的默认公开的更多信息，请参阅存储库方法公开。spring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：DELETEspring-doc.cn

  • 405 Method Not Allowed：如果方法未导出（通过 ）或存储库中不存在。delete(…)@RestResource(exported = false)spring-doc.cn

关联资源

Spring Data REST 为项目资源具有的每个关联公开每个项目资源的子资源。资源的名称和路径默认为 association 属性的名称，并且可以使用 association 属性进行自定义。@RestResourcespring-doc.cn

支持的 HTTP 方法

关联资源支持以下媒体类型：spring-doc.cn

GET

该方法返回关联资源的状态。GETspring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：GETspring-doc.cn

PUT

该方法将给定 URI 指向的资源绑定到关联资源（请参阅支持的媒体类型）。PUTspring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：PUTspring-doc.cn

  • 400 Bad Request：为一对一关联提供多个 URI 时。spring-doc.cn

支持的媒体类型

该方法仅支持一种媒体类型：PUTspring-doc.cn

  • text/uri-list：指向要绑定到关联的资源的 URI。spring-doc.cn

POST

该方法仅支持集合关联。它会向集合中添加一个新元素。POSTspring-doc.cn

支持的媒体类型

该方法仅支持一种媒体类型：POSTspring-doc.cn

  • text/uri-list：指向要添加到关联的资源的 URI。spring-doc.cn

DELETE

该方法将解除关联绑定。DELETEspring-doc.cn

自定义状态代码

该方法只有一个自定义状态代码：POSTspring-doc.cn

  • 405 Method Not Allowed：当关联为非可选时。spring-doc.cn

搜索资源

搜索资源返回存储库公开的所有查询方法的链接。可以使用 on 方法声明修改查询方法资源的路径和名称。@RestResourcespring-doc.cn

支持的 HTTP 方法

由于 search 资源是只读资源，因此仅支持该方法。GETspring-doc.cn

GET

该方法返回指向各个查询方法资源的链接列表。GETspring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：GETspring-doc.cn

相关资源

对于存储库中声明的每个查询方法，我们都会公开一个查询方法资源。如果资源支持分页，则指向它的 URI 是包含分页参数的 URI 模板。spring-doc.cn

HEAD

该方法返回搜索资源是否可用。404 返回代码表示没有可用的查询方法资源。HEADspring-doc.cn

Query Method 资源

查询方法资源通过存储库界面上的单个查询方法运行公开的查询。spring-doc.cn

支持的 HTTP 方法

由于 query method 资源是只读资源，因此仅支持。GETspring-doc.cn

GET

该方法返回查询结果。GETspring-doc.cn

参数

如果查询方法具有分页功能（在指向资源的 URI 模板中指示），则该资源采用以下参数：spring-doc.cn

  • page：要访问的页码（0 已编入索引，默认为 0）。spring-doc.cn

  • size：请求的页面大小（默认为 20）。spring-doc.cn

  • sort：格式为 ？.($propertyname,)+[asc|desc]spring-doc.cn

支持的媒体类型

该方法支持以下媒体类型：GETspring-doc.cn

HEAD

该方法返回查询方法资源是否可用。HEADspring-doc.cn