Stai visualizzando la documentazione per Looker 22.16. La documentazione più recente è disponibile qui.

Utilizzo di Explorer API

L'Explorer API di Looker è un'estensione, un'applicazione web creata utilizzando i componenti Looker, sviluppata tramite il framework delle estensioni di Looker e il cui deployment viene eseguito tramite Looker Marketplace.

Explorer API fornisce i seguenti asset:

Documentazione per tutti i metodi e i tipi di API Looker
Dichiarazioni del metodo e del tipo in tutte le lingue dell'SDK supportate
Link a funzioni SDK di esempio che utilizzano metodi API
Link alle pagine di Explorer API per i metodi e i tipi di riferimento
Una funzione Run It che consente di eseguire direttamente le chiamate API e fornisce il codice per le chiamate API, le risposte API e le funzioni SDK
Uno strumento di confronto che mostra le differenze nelle versioni dell'API Looker

Non è necessario che l'utente esegua l'accesso per la versione dell'estensione di Explorer API, perché API Explorer utilizza l'account attivo dell'utente per le richieste API. Questo assicura che l'utente possa eseguire solo le chiamate API a cui ha diritto, eliminando la necessità di fornire le credenziali API.

La funzionalità sudo come altro utente di Looker può essere utilizzata anche per effettuare richieste API come utente diverso per diagnosticare i problemi di accesso.

Installazione di Explorer API

Explorer API è disponibile su Marketplace di Looker.

Prima di installare Explorer API da Marketplace, è necessario che un amministratore di Looker attivi la funzionalità Extension Framework.

Per installare applicazioni, ad esempio Explorer per API, da Marketplace è necessario disporre delle autorizzazioni develop, manage_models e deploy. Una volta installato Explorer API, qualsiasi utente con almeno l'autorizzazione access_data sul modello extension_api_explorer può utilizzare Explorer API. Ogni utente può visualizzare tutti gli endpoint API in Explorer API, ma può eseguire solo quelli consentiti in base alle proprie autorizzazioni.

Se l'amministratore di Looker ha abilitato l'opzione Auto Install nella pagina Marketplace, nella sezione Platform del menu Admin di Looker, l'API Explorer verrà installato automaticamente sulla tua istanza. Inoltre, ogni volta che sono disponibili aggiornamenti, questi verranno applicati automaticamente, assicurando che la versione di Explorer API nell'istanza sia la più recente.

Se l'amministratore di Looker non ha abilitato l'opzione Auto Install (Installa automaticamente), dovrai installare l'API Explorer da Looker Marketplace.

Per istruzioni sull'installazione di un'estensione da Looker Marketplace, consulta la pagina della documentazione sull'uso di Looker Marketplace. Per assicurarti di avere sempre la versione più aggiornata di Explorer API, vai a Looker Marketplace, fai clic su Manage (Gestisci) e quindi sul pulsante Update (Aggiorna) accanto all'estensione.

Avvio di Explorer API

Una volta installato Explorer API, puoi raggiungerlo nei seguenti modi:

Dall'elenco delle applicazioni e delle estensioni installate nel menu Sfoglia.
Dalla pagina Applicazioni e strumenti, accessibile dal menu Sfoglia e dalla barra laterale sinistra
Se sei un amministratore di Looker, puoi anche accedere all'API Explorer facendo clic sul link Use API Explorer (Utilizza API Explorer) nella pagina di amministrazione dell'API di Looker.

Navigazione in Explorer API

Nella home page di Explorer API puoi eseguire le seguenti attività:

Utilizza il menu a discesa del selettore del linguaggio SDK per scegliere il linguaggio di programmazione in cui Explorer API mostrerà il metodo API e le dichiarazioni del tipo e i risultati del codice. Il selettore imposta come valore predefinito Python al caricamento iniziale. Se scegli All (Tutte) dal selettore lingua, Explorer API visualizza una visualizzazione a schede per ogni lingua supportata.
Utilizza il menu a discesa della versione per scegliere una versione dell'API:

- 4.0 - attuale

A partire da Looker 22.4, l'API Looker 4.0 è generalmente disponibile. Con questa versione, l'API 3.1 è stata ritirata e rimossa da Explorer API, rendendo l'API 4.0 l'unica versione disponibile per la visualizzazione su Explorer Explorer. Anche se la pagina di confronto di Explorer API esiste ancora per le release future, al momento non funziona perché l'API 4.0 è l'unica versione disponibile.

Inserisci un termine di ricerca nel campo Cerca per limitare i Metodi e i Tipi elencati solo a quelli che includono testo che corrisponde al tuo termine di ricerca:

Quando selezioni un metodo o un tipo restituito dalla ricerca, il termine di ricerca viene evidenziato nel riepilogo del metodo o del tipo.
Seleziona la scheda Metodi per visualizzare le categorie di metodi dell'API. Puoi espandere o comprimere una categoria di metodi per visualizzare i singoli metodi della categoria.
Seleziona la scheda Tipi per visualizzare i tipi di API. I tipi non sono classificati e sono elencati in ordine alfabetico.
Fai clic sull'icona con tre barre per nascondere o mostrare il pannello di navigazione di Explorer API.

Visualizzazione della documentazione del tipo e del metodo dell'API

Quando selezioni una categoria di metodo nella scheda Metodo, la categoria di metodo si espande e mostra tutti i metodi presenti nella categoria:

Nel riquadro principale, vengono visualizzati tutti i metodi di tale categoria. Puoi scegliere di visualizzare tutti i metodi della categoria o fare clic sulla scheda relativa a un determinato tipo di filtro per filtrare l'elenco in modo da visualizzare solo quel tipo di metodo.
Per visualizzare la documentazione relativa a un metodo specifico, scegli il nome del metodo nel pannello di navigazione o fai clic sul metodo nel riquadro principale.

Dopo aver selezionato un metodo specifico, Explorer API visualizza la documentazione relativa al metodo.

Quando selezioni un tipo dalla scheda Tipo, la relativa documentazione viene visualizzata nel riquadro principale:

Dichiarazioni relative a metodo e tipo

Explorer API esegue il rendering del metodo e delle dichiarazioni del tipo dell'SDK nel linguaggio dell'SDK scelto nel menu a discesa del selettore dell'SDK. Se il selettore della lingua dell'SDK è impostato su All, le dichiarazioni relative al metodo e al tipo vengono visualizzate in tutte le lingue dell'SDK supportate, separate da tabulazioni:

Esempi di SDK

Il repository sdk-codegen Looker contiene una cartella contenente esempi dell'SDK Looker. Se il repository sdk-codegen contiene esempi per un metodo, nella pagina Explorer API di metodo verrà visualizzata una sezione Esempi di SDK con i link agli esempi.

Se è selezionata una lingua specifica dell'SDK, vengono elencati per primi gli esempi relativi alla lingua in questione. Ad esempio, la seguente tabella SDK Example mostra Swift come lingua selezionata:

Potrebbero essere visualizzati anche esempi di Ruby e Java, sebbene non siano linguaggi di SDK.

Riferimenti

La sezione Riferimenti per ogni metodo e tipo include i link alle pagine di Explorer API per ogni metodo o tipo a cui fa riferimento il metodo o il tipo originale:

Utilizzo di Run It per richiedere e visualizzare le chiamate API

Explorer API include un pulsante Run It (Esegui) che apre un riquadro da cui puoi richiedere chiamate API e visualizzare le risposte in diversi formati supportati:

Quando fai clic sul pulsante Run It (Esegui), Explorer API visualizza una scheda Request (Richiesta), in cui puoi fornire gli input per il metodo dell'API:

Inserisci l'input desiderato e fai clic su Esegui per eseguire la chiamata API.

Ogni volta che il metodo API può modificare i dati (per qualsiasi chiamata REST che è POST, PATCH, UPDATE o DELETE), viene visualizzata la casella di controllo di conferma della modifica dei dati prima che la richiesta possa essere eseguita.

Quando la richiesta viene eseguita, la scheda Risposta mostra i risultati:

Inoltre, la scheda Codice mostra la sintassi delle chiamate dell'SDK scelta nel menu a discesa del selettore della lingua. Se il selettore della lingua dell'SDK è impostato su All, la sintassi delle chiamate dell'SDK viene mostrata in tutte le lingue dell'SDK supportate, separate da tabulazioni:

Tipi di visualizzazione della risposta

Le risposte di Explorer API includono un tipo MIME, utilizzato per determinare la modalità di visualizzazione dei risultati.

CSV e altri dati tabulari

Per CSV e JSON, viene eseguito un semplice test di forma per determinare se i dati hanno l'aspetto di una tabella. Se i dati dei payload sono simili a una tabella, la visualizzazione predefinita della risposta è una griglia di dati:

La scheda Grezzo può essere utilizzata per visualizzare i dati non trasformati:

JSON

I payload JSON possono essere "tabulari", nel qual caso saranno visualizzati in una griglia. Le intestazioni di colonna per la query LookML sono diverse per il formato JSON rispetto a quelle per il file CSV:

I payload JSON complessi omettono il display della griglia e mostrano solo il JSON non elaborato:

PNG e JPEG

Di seguito è riportato un esempio della stessa query riportata sopra, in formato PNG. JPEG viene gestito in modo simile:

SVG

Alcuni endpoint Looker restituiscono un file SVG, anch'esso supportato direttamente. Di seguito è riportato un esempio dell'endpoint content_thumbnail in formato SVG:

HTML

Il codice sorgente HTML è evidenziato nella scheda Risposta:

Testo

Le risposte SQL e altre risposte MIME digitate come testo normale vengono visualizzate in questo modo:

Confronto tra le versioni dell'API