API REST versioning e tipo di contenuto specifico del fornitore

Question

Ho letto molto sulla versione delle API REST, ad es. in questa discussione: Best practices for API versioning?

Per questo vorrei utilizzare l'intestazione HTTP-Accept per indicare quale versione richiede il client. Ma come posso applicare questo nella mia applicazione? Quali modifiche sono state quindi apportate? Come sa il marshaller, quale versione dovrebbe essere usata? Devo registrare il mio tipo?

Quello che so è che devo cambiare il contenuto del @Produces -Annotation

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

Ma che altro deve essere cambiato?

Answer 1

È possibile utilizzare i Variant meccanismi di JAX-RS.

@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(); 
} 

Vedere anche lo Java EE 6 Tutorial.

Modifica

Non c'è modo automatico per schierare un'entità secondo la variante selezionata. Ciò richiede un po 'di lavoro manuale. Ad esempio:

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(); 

Se le versioni sono abbastanza diverse, utilizzerei una classe annotata JAXB per ogni versione. Ciascuna classe includerebbe quindi solo quelle proprietà valide per questa versione. JAX-RS si occupa di portarli in JSON.

Answer 2

Per quanto ne so non è possibile utilizzare JAX-RS per l'instradamento automatico a diversi metodi basati su un'intestazione http.

È possibile leggere l'intestazione dentro di voi il metodo (con @HeaderParam o HttpHeaders sulla @context vedi here) e chiamare il appropriata versione