如何自定义 Spring Data REST 以对存储库资源使用多段路径?

How to customize Spring Data REST to use a multi-segment path for a repository resource?

我正在使用 Spring Data JPA 和 Spring Data REST 开发基于组件的 CRUD 应用程序。我有几个组件。例如 system 组件有 User 模型和 UserRepository。组件由包名称区分。喜欢 com.example.app.<component_name>

所以为了让我的 REST API 看起来更干净,我需要实现 API URL 如下。

host:8080/<component_name>/<model_collection_name>

例如

host:8080/system/users

我在我的存储库中执行了以下操作

@RepositoryRestResource(collectionResourceRel = "users", path = "system/users")
public interface UserRepository extends PagingAndSortingRepository<User, Long> {
   ...
}

这会生成以下内容,当我转到 http://localhost:8080

{
   "_links": {
   "users": {
   "href": "http://localhost:8080/system/users{?page,size,sort}",
    "templated": true
},
...

但是当我转到 http://localhost:8080/system/users

报错

Fri May 22 17:56:37 IST 2015 There was an unexpected error (type=Not Found, status=404). No message available

注意 :如果我将路径映射到 system-users 那么它工作正常,但是当我在路径如 system/users,它中断并给出错误。

我认为这个(或:类似的)问题已经在 Whosebug 上得到了回答 here

使用自定义 RepositoryRestMvcConfiguration 设置基本 uri class。

tl;博士

不支持。

详情

一般来说:不要专注于设计 URL。根据定义,URI 的结构对于 REST 客户端而言必须无关紧要:

At no time whatsoever do the server or client software need to know or understand the meaning of a URI -- they merely act as a conduit through which the creator of a resource (a human naming authority) can associate representations with the semantics identified by the URI.

(来自 Roy Fielding - 建筑风格和 基于网络的软件架构设计 - Section 6.2.4)

如果您遵循该标准,您将负责选择关系名称、设计您公开的资源的表示等。

也就是说,目前不支持您查找的内容。如果您认为值得添加此功能(由于上面给出的论点,我认为不值得),请随时在我们的 bug tracker.

中开票

由于 Spring MVC 映射的工作方式,实现起来可能相当棘手,尤其是奇异路径段和非奇异路径段的映射组合可能会导致一些歧义。所有这些使得该请求不太可能得到跟进。