Il modo migliore per gestire la versione dell'URI dell'API REST JAX-RS

Question

Ho effettuato la prima ricerca in StackOverflow & Non sono riuscito a trovare alcuna risposta relativa alla mia domanda. Tutto quello che posso trovare sono domande relative al progetto uri REST.

La mia domanda sul lato back-end. Supponiamo di avere due differenti versioni di REST uri di

http://api.abc.com/rest/v1/products

http://api.abc.com/rest/v2/products

Qual è l'approccio migliore per seguire sul lato backend (codice lato server) per il corretto instradamento, gestibilità & riutilizzo dell'esistente le classi attraverso questi due set di API si basano sulla versione?

Ho pensato ad un approccio per definire le classi di risorse con diverse annotazioni @Path per es. avere un pacchetto per v1 & v2 separatamente & in classe ProductsResource di quel pacchetto, definire

package com.abc.api.rest.v1.products; 
    @Path("/rest/v1/products") 
    public class ProductsResource {...} 

    package com.abc.api.rest.v2.products; 
    @Path("/rest/v2/products") 
    public class ProductsResource {...} 

& quindi hanno la logica implementazione basata sulle versioni. I problemi con questo approccio sono quando cambiamo solo una particolare risorsa API dal set di API, dobbiamo copiare anche altre classi nel pacchetto v2. Possiamo evitarlo?

Come scrivere un'annotazione personalizzata dire @Version & hanno valori delle versioni che supporta? Ora se è v1 o v2, entrambe le richieste andranno alla stessa classe di risorse.

Dire per es.

package com.abc.api.rest.products; 
    @Path("/rest/{version: [0-9]+}/products") 
    @Version(1,2) 
    public class ProductsResource {...} 

UPDATE:

C'era un'API delle versioni suggerimento di Jarrod per gestire la versione nelle intestazioni. Anche questo è un modo per farlo, sto cercando le migliori pratiche da utilizzare quando stiamo seguendo il controllo delle versioni degli URI

Answer 1

Il problema con il metterlo nell'URL è che l'URL dovrebbe rappresentare una risorsa in base alla posizione. Una versione API non è un percorso e non fa parte dell'identificatore della risorsa.

L'inserimento di /v2/ nell'URL interrompe tutti i collegamenti esistenti precedenti.

Ci sono due modi adeguati per specificare API delle versioni:

1. metterlo nel mime-type per il Accept: intestazione che si desidera. Qualcosa come Accept: application/myapp.2.0.1+json

2. Non inserirlo nell'URL Header. Quindi il tuo metodo che sta gestendo la risorsa può guardare allo Header e determinare quale metodo o oggetto di gestione da inviare a. Qualcosa di simile Version: 2.0.1

Chain of Responsiblity modello va bene qui, specialmente se ci sarà significativo numero di versioni di API che sono abbastanza diversi per avere il proprio gestore, che i metodi di modo non ci sfugga di mano.

Answer 2

Questo post del blog ha un esempio di quello che è considerato il da alcuni come l'approccio corretto, vale a dire non avere la versione nella URI: http://codebias.blogspot.ca/2014/03/versioning-rest-apis-with-custom-accept.html

In breve, si sfrutta JAX-RS @Consume annotazioni per associare la richiesta per una particolare versione di una specifica implementazione, come:

@Consumes({"application/vnd.blog.v1+xml", "application/vnd.blog.v1+json"}) 

Answer 3

mi stavo chiedendo perché non hanno una sottoclasse di ProductService chiamato

@Path(/v2/ProductService) 
ProductServiceV2 extends ProductService { 


} 


@Path(/v1/ProductService) 
class ProductService{ 


} 

e sovrascrive solo ciò che è cambiato in v2. Tutto invariato funzionerà come in v1/ProductService.

Questo defintely porta a più # di classi, ma è un modo più semplice di codifica per solo ciò che sta cambiando nella nuova versione di API e ripristinando la vecchia versione senza duplicare il codice.