春季REST HATEOAS

Question

我正在尝试遵循最佳实践，想象一个带有/ books端点的基本API。

我有以下类：Book BookRepository（PagingAndSortingRepository，但未导出！）BookController（这是服务类）BookResource（“状态状态转移”中该书的“表示”）BookResourceAssembler

我的BookController看起来像这样：

@RequestMapping(path="/{id}", method = RequestMethod.GET)
    public ResponseEntity<?> getBook(@PathVariable Long id) {
        Book book = bookRepository.findOne(id);
        BookResource bookResource = this.bookResourceAssembler.toResource(book);
        return ResponseEntity.ok(bookResource);
    }

我的BookResource看起来像这样：

public class BookResource extends ResourceSupport{
    public String title;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

}

BookResourceAssembler：

@Component
public class BookResourceAssembler extends ResourceAssemblerSupport<Book, BookResource> {

      public BookResourceAssembler() {
        super(BookController.class, BookResource.class);
      }


    @Override
    public BookResource toResource(Book entity) {
        BookResource resource = createResourceWithId(entity.getDbid(), entity);
        return resource;
    }
}

我想我的第一个问题很容易解决，标题未初始化，因此当我调用/ books / 1时，标题为：null。

第二个也是更重要的问题是如何进行内容协商和版本控制，这是RESTful API的一个非常重要的方面。 我应该如何介绍BookResourceV2，并在哪里进行谈判？ 假设我要

"Content-Type: application/vnd.company.book+json.v2"

我在哪里注明？ 我应该添加哪些新的类/函数来处理同一资源的此v2？

我找不到涵盖所有方面的优秀教程。

Answer 1

我想我的第一个问题很容易解决，标题未初始化，因此当我调用/ books / 1时，标题为：null。

您使用BookResource的方式错误。 我假设您的域对象（书）看起来像：

public class Book {
    public String title;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

}

BookResource是一个包装器，它添加到域对象的链接并以RESTful方式呈现。

public class BookResource extends Resource<Book> {

    public BookResource(Book content, Link... links) {
        super(content, links);
    }

}

作为记录，在这种情况下，您甚至不需要自定义Resource和ResourceAssembler类：

@RequestMapping(path="/{id}", method = RequestMethod.GET)
public ResponseEntity getBook(@PathVariable Long id,
    PersistentEntityResourceAssembler assembler) {
    Book book = bookRepository.findOne(id);
    if (null == book) {
        throw new ResourceNotFoundException();
    }

    return ResponseEntity.ok(assembler.toResource(book));
}

在这种非常简单的情况下（无需对Book实例进行特殊处理），您甚至不需要此端点，因为Spring会为您生成它。

第二个也是更重要的问题是如何进行内容协商和版本控制，这是RESTful API的一个非常重要的方面。 我应该如何介绍BookResourceV2，并在哪里进行谈判？

您需要定义一个RepositoryRestController并使用带有RequestMapping控制器端点的produces参数，类似于我在本文中所解释的 。