Norme relative al supporto di SDK e API Looker

Looker fornisce più versioni API e più SDK del linguaggio 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 e gli SDK dell'API Looker hanno diversi livelli di supporto:

I livelli di assistenza sono descritti nelle sezioni seguenti.

Supporto di Looker

Looker supporta queste versioni dell'API e gli SDK per le lingue. I ticket di assistenza possono essere inviati all'assistenza Looker e in conformità 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 disponibile al livello di assistenza dalla community per diversi motivi:

  • Non dispone delle funzionalità necessarie per raggiungere il livello supportato da Looker.
  • Ha bisogno di maggiore supporto e infrastruttura di automazione (test automatici, pacchettizzazione, documentazione, esempi e così via) prima di poter essere completamente supportato da Looker.
  • Si basa su una tecnologia deprecata.
  • Non è stato testato da un numero sufficiente di utenti diversi per essere ritenuto pronto per uscire dalla fase "alpha" .

Non supportata

Non viene fornita assistenza. Le versioni 3.0 e 3.1 dell'API non sono supportate.

Versioni 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 Rimossa Questa API è stata rimossa da Looker.
3.1 Non supportata Rimossa 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.

Eventuali versioni future dell'API verranno introdotte come alpha e quindi seguiranno i cicli di vita beta, stabili e deprecati.

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 Utensili Descrizione
Ruby Looker Scritto a mano L'SDK Ruby attuale legge la specifica dell'API di Looker per costruire in modo dinamico i metodi dell'SDK.
Python Looker codegen L'SDK Python viene utilizzato ovunque sia possibile utilizzare Python. Consulta il readme dell'SDK Python per le informazioni più recenti sulle versioni 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 Gli SDK di altri 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: viene generato dallo strumento OpenSource Generatore di codice Swagger. Per i linguaggi di programmazione non direttamente supportati dal generatore di codice di Looker, abbiamo fornito un'opzione per il generatore legacy nel repository codegen che dovrebbe semplificare la generazione personalizzata. Questo "legacy" generatore di codice usa il generatore di codice OpenAPI OpenSource, 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

Looker ha recentemente adottato uno schema di controllo delle versioni che associa gli SDK del linguaggio 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 per i linguaggi

Gli SDK del linguaggio più recenti (prodotti dal codegen di Looker) corrispondono alle versioni di release di Looker. Ad esempio, gli SDK Python e TypeScript corrispondono alle rispettive versioni di release 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.