Siamo lieti di annunciare che l'API Looker 4.0 è generalmente disponibile in Looker 22.4. L'API 4.0 (API API 4.0 GA) generalmente disponibile contiene più modifiche che provocano errori e additivi e promuove più endpoint da beta a stabile. Le API 3.1 e 3.0 non sono interessate. Consulta il nostro riferimento API per le specifiche dettagliate sull'API 4.0. Abbiamo aggiornato gli SDK supportati da Looker e supportati dalla community per supportare gli endpoint GA dell'API Looker 4.0. Per ulteriori informazioni, vedi le norme relative al supporto di API e SDK e il controllo delle versioni dell'API. Il resto di questo articolo illustra le modifiche che provocano un errore, le mitigazioni e le funzionalità che puoi aspettarti quando si esegue la migrazione all'API API 4.0.
Chi dovrebbe leggerlo?
Questo documento è per te se utilizzi l'API Looker tramite SDK supportati da Looker, SDK supportati dalla community o l'API stessa. Leggi la sezione seguente che è mappato alla versione dell'API Looker che stai utilizzando.
Utenti dell'API pre-GA 4.0
Se utilizzi l'API 4.0, leggi questa sezione. Copre le modifiche che provocano errori e le mitigazioni disponibili quando si esegue la migrazione all'API 4.0 GA in Looker 22.4.
L'API 4.0 GA include la modifica di tutti i campi dell'ID entità dal tipo numerico integer
al tipo string
. Ad esempio, GET /groups/{group_id}
endpoint restituisce id
come tipo string
anziché tipo int64
.
Leggi la seguente tabella sull'impatto e sulle mitigazioni specifiche per l'utilizzo degli endpoint API 4.0:
Utilizzo | Potenziale impatto1 | Prevenzione |
App mobile Looker | Le installazioni obsolete delle app mobile Looker vengono interrotte | Chiedi agli utenti di eseguire l'aggiornamento all'ultima versione delle app mobile di Looker |
SDK Looker supportati2 | ||
SDK TypeScript (API 4.0) | Nessun impatto | Nessuna azione richiesta |
SDK Python (4.0 API) | Nessun impatto | Nessuna azione richiesta |
SDK Ruby (API 4.0) | Nessun impatto | Nessuna azione richiesta |
SDK supportati dalla community2 | ||
SDK Swift | Eccezioni runtime | Aggiorna l'SDK alla versione 22.0+; risolvi eventuali errori di tipo generati |
SDK Kotlin | Nessun impatto | Nessuna azione richiesta |
SDK Looker | Nessun impatto | Nessuna azione richiesta |
SDK C# | Nessun impatto | Nessuna azione richiesta |
SDK Go | Eccezioni runtime | Aggiorna l'SDK alla versione 22.0+; risolvi eventuali errori di tipo generati |
Altro | ||
Utilizzare l'API 4.0 senza un SDK (o con librerie fornite esternamente) | Possibili errori di runtime, a seconda della sensibilità del tipo della lingua | Esamina il codice per verificare le dipendenze dal tipo di qualsiasi campo ID e aggiungi il supporto per i campi ID di tipo stringa. Leggi anche queste linee guida aggiuntive. |
1: supporre pattern di utilizzo comuni che potrebbero includere l'utilizzo dei campi ID di Looker, ma non pattern di utilizzo insoliti, come l'applicazione di operazioni numeriche agli ID.
2: Supporto di API e SDK di Looker. Le librerie supportate dalla community non sono ufficialmente supportate da Looker.
Utenti di API 3.1
Se utilizzi l'API 3.1, leggi questa sezione. e riguarda le funzionalità e le modifiche aggiuntive che l'API 4.0 mette a tua disposizione. Ricorda che tutti i nostri SDK supportati da Looker e supportati dalla community supportano principalmente l'API 4.0. Per ulteriori informazioni, consulta le norme di assistenza per SDK e API.
Funzionalità aggiuntive dell'API 4.0 GA
Per praticità, indichiamo per te le modifiche all'API 4.0 aggiuntive più rilevanti e utili:
- Creazione, gestione e creazione di schede e schede per le schede. La documentazione di bordo è qui.
- Esegui query su informazioni aggiuntive sulla connessione come database, schemi, colonne e tabelle. Impostare e aggiornare altri campi di connessione.
- Creazione e gestione di app e utenti OAuth. La documentazione di OAuth è disponibile qui.
- Cerca gruppi con gerarchia e ruoli.
- Ruoli di ricerca con il conteggio utenti.
- Scarica e configura le impostazioni dell'istanza di Looker. La documentazione delle impostazioni è disponibile qui.
- Creazione e gestione degli avvisi. La documentazione degli avvisi è disponibile qui.
- Creazione di tunnel SSH, server SSH e gestione e test. La documentazione di SSH è disponibile qui.
- Sposta e copia le dashboard.
- Ottieni URL relativi per le nuove dashboard.
- Sposta e copia i look.
- Secret e SSO da incorporare, creazione e gestione degli utenti.
- Richiedi un token di aggiornamento per aggiornare il token di accesso.
- Limita e compensa i risultati della ricezione di tutti i modelli LookML e di tutti gli utenti.
- Limitare e compensare i risultati della ricerca di utenti.
- Recupera le specifiche dell'API Looker in Swagger 2.x JSON.
Modifiche al ritiro di GA 4.0
L'API 4.0 GA sostituisce diversi endpoint API 3.1 deprecati con funzionalità migliorate. Di seguito sono elencati gli endpoint interessati:
- Gli endpoint della home page deprecati sono stati rimossi. Utilizza gli endpoint della scheda anziché le home page. Vedi Presentare contenuti con le lavagne.
- Gli endpoint deprecati per lo spazio sono stati rimossi. Utilizza gli endpoint delle cartelle anziché lo Spazio. Vedi Organizzare e gestire l'accesso ai contenuti.
Utenti di API 3.0
L'API 3.0 è ritirata ed è consigliabile eseguire la migrazione all'API 4.0.
- Solo l'API 4.0 supporta tutti gli SDK supportati da Looker e supportati dalla community per facilitare il tuo sviluppo. Consulta il nostro repository SDK.
- L'API 4.0 introduce diverse nuove funzionalità e miglioramenti come sopra elencato.
Conclusione
Puoi aspettarti l'aggiunta di nuove funzionalità e modifiche aggiuntive all'API 4.0 e troverai sempre le ultime modifiche nel nostro riferimento API. Per ulteriori informazioni, vedi le norme relative al supporto di API e SDK e il controllo delle versioni dell'API. Sappiamo bene che le modifiche che provocano un errore non sono l'ideale. A meno che non si verifichi un problema estremo, non apporteremo modifiche che provocano errori alla nostra API 4.0 generalmente disponibile. Ci auguriamo che la nostra API Looker 4.0, generalmente disponibile, ti aiuti a sviluppare in modo più semplice e produttivo la piattaforma Looker.