Norme di assistenza per l'API e l'SDK di Looker

Looker fornisce più versioni dell'API e più SDK per lingua che utilizzano queste API. Questo documento descrive lo stato e le norme di assistenza per le versioni dell'API Looker e gli SDK per le lingue.

Livelli di assistenza

Le versioni dell'API Looker e gli SDK hanno diversi livelli di supporto:

I livelli di assistenza sono descritti nelle sezioni seguenti.

Supportato da Looker

Looker supporta queste versioni dell'API e gli SDK per le lingue. I ticket di assistenza possono essere inviati all'assistenza Looker e devono essere conformi alle linee guida dell'assistenza Looker. Solo l'API 4.0 è supportata da Looker.

Supportato dalla community

Questo livello si applica solo agli SDK per le lingue. I problemi vengono registrati e gestiti nel repository open source utilizzato per l'SDK.

Un SDK per le lingue può essere al livello di assistenza della community per diversi motivi:

  • Mancano le funzionalità necessarie per raggiungere il livello supportato da Looker.
  • Prima di poter essere supportato completamente da Looker, ha bisogno di più assistenza e infrastruttura di automazione (test automatici, pacchetti, documentazione, esempi e così via).
  • Si basa su una tecnologia deprecata.
  • Non è stato testato da un numero sufficiente di utenti diversi per essere considerato pronto a uscire dallo stato "alpha".

Non supportata

Non viene fornito alcun supporto. Le versioni 3.0 e 3.1 dell'API non sono supportate.

Versioni dell'API

La tabella seguente elenca le tre versioni dell'API documentate a partire da Looker 22.4 e mostra i relativi livelli di assistenza.

Versione Assistenza Stato Descrizione
3.0 Non supportata Rimosso Questa API è stata rimossa da Looker.
3.1 Non supportata Rimosso Questa API è stata rimossa da Looker.
4.0 Looker Stabile Release attuale. È comunque possibile aggiungere nuovi endpoint, argomenti e proprietà di struttura. Tutti gli SDK per i linguaggi Looker supportati utilizzano l'API 4.0.

Le versioni future dell'API verranno introdotte come alpha e poi passeranno attraverso i cicli di vita beta, stabile e ritirata.

SDK in più linguaggi

Gli SDK per i linguaggi di Looker si sono evoluti nel corso del tempo e vengono prodotti con una serie di strumenti e tecniche. Tutti gli SDK utilizzano direttamente o indirettamente i documenti delle specifiche dell'API di Looker. Lo stato di assistenza degli SDK per le lingue è descritto nella tabella seguente.

Lingua Assistenza Strumenti Descrizione
Ruby Looker Scritto a mano L'attuale SDK Ruby legge la specifica dell'API Looker per costruire dinamicamente i metodi dell'SDK.
Python Looker codegen L'SDK Python viene utilizzato ovunque sia possibile utilizzare Python. Consulta il file readme dell'SDK Python per le informazioni più recenti sulle versioni di Python supportate.
TypeScript Looker codegen L'SDK TypeScript viene utilizzato sia per le applicazioni Node sia per quelle browser.
Kotlin Community codegen L'SDK Kotlin viene utilizzato per le applicazioni mobile Android e Java Virtual Machine (JVM).
Swift Community codegen L'SDK Swift viene utilizzato per le applicazioni per iOS e macOS.
R Community Swagger LookR è l'SDK di Looker per il linguaggio di programmazione R e funziona con R Studio.
Altro Community codegen Altri SDK di linguaggi generati dal progetto codegen di Looker, come C# (Look#) e Go (GoLook), sono supportati dalla community. I problemi devono essere segnalati nel repository sdk-codegen.

Legenda degli strumenti

  • codegen: generato dal progetto SDK codegen di Looker e utilizza una libreria di runtime scritta a mano per ogni SDK.
  • Swagger: generato dallo strumento open source Swagger Code Generator. Per i linguaggi di programmazione non supportati direttamente dal generatore di codice di Looker, abbiamo fornito un'opzione di generatore precedente nel repository codegen che dovrebbe semplificare la generazione personalizzata. Questo generatore "legacy" utilizza il generatore di codice OpenAPI open source, che sostituisce il generatore di codice Swagger.
  • Scritto a mano: tutto il codice sorgente viene scritto a mano senza generazione di codice.

Versionamento dell'SDK

Di recente Looker ha adottato uno schema di versionamento che associa gli SDK per i linguaggi alla release di Looker utilizzata per generarli. Ad esempio, ciò significa che un SDK prodotto utilizzando le specifiche di Looker 21.10 avrà una versione che inizia con 21.10.*.

SDK in più linguaggi

Gli SDK per i linguaggi più recenti (prodotti da Looker codegen) corrispondono alle versioni di release di Looker. Ad esempio, gli SDK Python e TypeScript corrispondono alle rispettive versioni di rilascio di Looker.

Quando trasferiamo gli SDK di linguaggi precedenti a codegen o pubblichiamo gli SDK codegen esistenti nei relativi gestori pacchetti, la versione dell'SDK verrà impostata in modo da corrispondere alla versione di rilascio di Looker.

Versioni dei pacchetti delle librerie di runtime

L'SDK TypeScript dipende da un pacchetto di librerie di runtime (RTL) separato, scritto da Looker, che supporta in modo generico le API REST. Poiché non è specifico per nessuna release di Looker, questo pacchetto viene sottoposto a versionamento indipendentemente dagli SDK per i linguaggi che lo utilizzano.

Quando altri SDK di lingua vengono pubblicati nei gestori pacchetti, i relativi RTL potrebbero diventare un pacchetto separato. Qualsiasi pacchetto RTL separato utilizzerà la versione semantica anziché le versioni di release di Looker corrispondenti.