如何配置Spring REST服务来处理多个版本？

Question

null

null

// on V1 Question look like this:
public class project.domain.Question
{
    private String question;
}

// on v2 Question looks like this:
public class project.domain.Question
{
    private String question;
    private Date creationDate;
}


@Service
public class project.service.QuestionService
{
    public long create(Question q) {...};
    public Question read(long id) {...};
    public void remove(long id) {...};
    public void update(Question qd) {...};

}


@Controller
@RequestMapping("/v2/question")
public class project.web.v2.QuestionController
{
    @Autowired
    project.service.QuestionService questionService;

    @RequestMapping(method = RequestMethod.POST)
    @ResponseBody
    public long create(Question q)
    {
        return questionService.create(q);
    }
}

@Controller
@RequestMapping("/v1/question")
public class project.web.v1.QuestionController
{
    @Autowired
    project.service.QuestionService questionService;

    @RequestMapping(method = RequestMethod.POST)
    @ResponseBody
    public long create(Question q)
    {
        // this will not work, because the v1 haven't had the 'creationDate' field.
        return questionService.create(q);
    }
}

Answer 1

REST API的版本化是一个复杂的问题。首先，让我们确定一些版本控制的高级方法：

• URI版本控制-资源被认为是不可变的，我们使用版本指示符在资源表示中创建一个新的URI空间更改
• 语言扩展/版本控制-考虑到正在更改的是资源的表示形式，此解决方案将在不影响URI空间的情况下对表示形式本身进行版本化

考虑到这一点，让我们考虑一些目标：（直接从API演进）

null

语言的设计应该明确地考虑到前向兼容性，客户应该忽略他们不理解的信息。

因此，将信息添加到资源的表示形式并不是不兼容的更改。

这种对语言的扩展/更改可以利用Accept头和内容协商--使用自定义供应商MIME媒体类型对表示进行版本控制。这些文章更深入地讨论了以下内容：API版本控制、REST Web服务版本控制。

null

其他一些非常有用的资源：

• 版本兼容性策略

希望这有帮助。