扩展Spring Data Rest索引资源链接

时间:2017-02-03 15:09:25

标签: spring spring-data-rest spring-hateoas

我将所有api端点映射到基本网址/api/下。现在,我希望通过HATEOAS使用spring-data-rest来公开所有可用的端点,以便客户端应用程序可以处理这些信息。默认情况下,这似乎是开箱即用的,因为GET /api/会返回所有找到的Spring存储库及其各自的URL:

{
  "_links" : {
    "news" : {
      "href" : "http://localhost:8080/api/news{?page,size,sort,projection}",
      "templated" : true
    }
  }
}

但是,我想添加一些自定义链接到其他资源。我试过这个:

@RequestMapping("/api")
public class AppController {

  @RequestMapping("/")
  public ResponseEntity<ResourceSupport> getEndpoints () {
      ResourceSupport resource = new ResourceSupport();

      resource.add(linkTo(UserController.class).withRel("users"));

      return new ResponseEntity<>(resource, HttpStatus.OK);
  }
}

但这实际上会覆盖一切。所以我的问题是如何使用一些自定义链接扩展基本资源的spring-data-rest的标准输出?

2 个答案:

答案 0 :(得分:5)

我假设您使用的是spring-data-rest

要添加指向服务索引资源的链接,您必须编写ResourceProcessor<RepositoryLinksResource>

生成索引资源时将调用此处理器,您可以使用它来添加索引资源的链接。

以下是一个例子:

/**
 * Adds custom controller links to the index resource
 */
@Component
public class RepositoryLinksResourceProcessor implements ResourceProcessor<RepositoryLinksResource> {

    @Override
    public RepositoryLinksResource process(RepositoryLinksResource resource) {
        resource.add(linkTo(UserController.class).withRel("users"));
        return resource;
    }
}

答案 1 :(得分:0)

Spring Boot Version 2.4.4下,您可以

@Component
public class RepositoryLinksResourceProcessor extends ProfileResourceProcessor {

    /**
     * Creates a new {@link ProfileResourceProcessor} with the given {@link RepositoryRestConfiguration}.
     *
     * @param configuration must not be {@literal null}.
     */
    public RepositoryLinksResourceProcessor(RepositoryRestConfiguration configuration) {
        super(configuration);
    }

    @Override
    public RepositoryLinksResource process(RepositoryLinksResource resource) {
        return super.process(resource);
    }
}