版本控制REST REST API和供应商特定内容类型

Question

我读了很多有关版本的REST API，F.E的读取。在此线程中：API版本的最佳实践？

因此，我想使用http-proc-header表示客户端要求的版本。但是如何将其应用于我的应用程序？因此，已经进行了哪些更改？卫生员如何知道应该使用哪个版本？我必须注册我的类型吗？

我所知道的是，我必须更改@Produces的内容

@GET
@Path("/locations")
@Produces("application/vnd.mycompany-v1+xml")
Location[] getLocations();

但是还必须更改什么？

Answer 1

您可以使用JAX-RS的Variant机制。

@GET
@Path("/locations/{id}")
@Produces(value = {"application/vnd.mycompany-v2+json", // current version
                   "application/vnd.mycompany-v1+json", // old version
                   MediaType.APPLICATION_JSON})         // fallback
public Response getLocation(@PathParam("id") Integer id,
                            @Context Request request) {
    MediaType vndTypeV1 = new MediaType("application", "vnd.mycompany-v1+json");
    MediaType vndTypeV2 = new MediaType("application", "vnd.mycompany-v2+json");
    Variant variant1 = new Variant(vndTypeV1, null, null);
    Variant variant2 = new Variant(vndTypeV2, null, null);
    Variant variantJson = new Variant(MediaType.APPLICATION_JSON_TYPE, null, null);
    List<Variant> variants = new ArrayList<Variant>();
    variants.add(variant1);
    variants.add(variant2);
    variants.add(variantJson);
    Variant selectedVariant = request.selectVariant(variants);
    Location location = someBackendService.getLocation(id);
    // Manipulate location according to which variant is the selectedVariant.
    // ...
    return Response.ok("{}")
        .header(HttpHeaders.CONTENT_TYPE, selectedVariant.getMediaType())
        .build();
}

也请参见Java EE 6教程。

编辑

根据选定的变体没有自动方法来元帅实体。这需要一些手动工作。例如：

String version = extractVersionFromVariant(selectedVariant);
if ("v1".equals(version)) {
    location.setSomeV1Propery("only in v1);
} else if ("v2".equals(version)) {
    location.setSomeV2Propery("only in v2);
}
return Response.ok(location)
               .header(HttpHeaders.CONTENT_TYPE, selectVariant.getMediaType())
               .build();

如果版本足够不同，我将为每个版本使用JAXB注释的类。然后，每个这样的类仅包含对此版本有效的属性。jax-rs谨慎地将其元帅到JSON。

Answer 2

据我所知，您不能使用JAX-RS自动根据HTTP标头路由到不同方法。

您可以读取方法中的标题（ @context上的@headerparam或httpheaders请参见此处），并调用适当的版本