Guide di integrazione › Guida di riferimento dell'API di Backbone Fabric Controller (BFC) › Costruzione dell'URL › Raggruppamento dell'API e controllo delle versioni

Raggruppamento dell'API e controllo delle versioni

Le API di BFC vengono raggruppate mediante il prefisso dell'applicazione BFC nell'URL. Il prefisso dell'applicazione seguirà direttamente l'host nell'URL.

Tutte le API supportano il controllo delle versioni. I numeri di versione dell'API sono relativi all'API stessa, non al BFC. Pertanto, la versione dell'API non deve essere modificata assieme alla versione di BFC. Una versione dell'API ha due parti, il numero principale e il numero secondario. Più versioni delle API possono coesistere allo stesso tempo. Le procedure per interrompere il supporto per una versione verranno identificate in un secondo momento, ma la compatibilità con le versioni precedenti non verrà mai interrotta in una versione in cui cambia solamente il numero dell'API. I record di payload possono variare tra le versioni. L'URL utilizzato per identificare le versioni dell'API identificherà anche la versione del record. Il record stesso non conterrà un numero di versione. Comunque, alcune API possono decidere di includere la versione nel nome del record.

La disponibilità iniziale delle API di BFC sarà nella versione 3.5.0 di BFC. La versione dell'API iniziale sarà 1.0. Un client richiede una versione dell'API stabilendo una sessione con un URI di accesso della versione esplicito. Ogni versione di BFC supporterà un URI di accesso della versione esplicito per ciascuna versione dell'API supportata. Nessun URI diverso dall'accesso conterrà numeri di versione espliciti.

Esempi di URL per la versione iniziale:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/...

Se, ipoteticamente, una versione futura di BFC contenesse una modifica alle API della griglia e si desiderasse continuare il supporto per l'API 1.0, nella nuova versione possono essere supportati i seguenti URL:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/1.1/login
https://<bfchost>:8443/BFC/grids/...

Tenere presente che la versione 1.1 potrebbe contenere anche nuove API non presenti nella 1.0, nel qual caso possono essere introdotti nuovi URL:

https://<bfchost>:8443/BFC/servers/...

Un client che ha eseguito l'accesso all'URI 1.0 non avrà accesso all'URI dei nuovi server (i tentativi di accesso restituirebbero un errore HTTP 404).