Utilizzo di Explorer API

Nota: a partire dalla versione 22.4 di Looker, l'API Looker 4.0 è in disponibilità generale. L'API 3.1 è deprecata.

L'Explorer API di Looker è un'estensione, un'applicazione web creata utilizzando i componenti Looker, sviluppata mediante il framework delle estensioni 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 tutti i linguaggi SDK supportati
• Link a esempi di funzioni SDK che utilizzano metodi API.
• Link alle pagine Explorer API per i tipi e i metodi di riferimento
• Una funzione Esegui che consente di eseguire direttamente le chiamate API e fornisce il codice per le chiamate API, le risposte dell'API e le funzioni dell'SDK.
• Uno strumento di confronto che mostra le differenze nelle versioni dell'API Looker

Non è necessario che l'utente acceda alla versione dell'estensione di Explorer API, perché Explorer API utilizza l'account dell'utente attivo per le richieste API. Ciò garantisce che l'utente possa eseguire solo le chiamate API a cui ha diritto, eliminando al contempo la necessità di fornire le credenziali API.

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

Installazione di Explorer API

Explorer API è disponibile nel Marketplace di Looker.

Prima di installare Explorer API dal Marketplace, un amministratore Looker deve abilitare la funzionalità Framework delle estensioni.

L'installazione di applicazioni, come l'estensione Explorer API, da Marketplace richiede che tu disponga delle autorizzazioni develop, manage_models e deploy. Una volta installato Explorer API, qualsiasi utente con 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 dalle sue autorizzazioni.

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

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

Per istruzioni sull'installazione di un'estensione da Looker Marketplace, consulta la pagina della documentazione Utilizzo di Looker Marketplace. Per assicurarti di avere sempre la versione più aggiornata di Explorer API, vai a Looker Marketplace, seleziona Gestisci e seleziona il pulsante Aggiorna accanto all'estensione.

Nota: se installi Explorer API su un'istanza Looker ospitata dal cliente, per poter visualizzare gli esempi di API il server che esegue l'istanza di Looker deve essere configurato per accedere al server Internet pubblico in esecuzione all'URL https://githubusercontent.com.

Avvio di Explorer API

Dopo aver installato l'Explorer API, puoi accedervi dalla sezione Applicazioni della barra laterale a sinistra.

Nota: se sei un amministratore di Looker, puoi accedere ad Explorer API anche selezionando il link Use API Explorer (Utilizza Explorer API) nella pagina amministrativa API di Looker.

Navigazione in Explorer API

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

1. 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 Tutte dal selettore lingua, Explorer API mostra una visualizzazione a schede per ogni lingua supportata.

2. Usa il menu a discesa della versione per scegliere una versione dell'API:

   • 4,0 - corrente
   • 3.1 - legacy

3. Seleziona il pulsante Confronta specifiche per aprire la pagina di confronto delle versioni API.

4. Inserisci un termine di ricerca nel campo Cerca per limitare i Metodi e i Tipi elencati solo a quelli che includono testo corrispondente al 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.

5. Seleziona la scheda Metodi per visualizzare le categorie di metodi dell'API. Puoi espandere o contrarre una categoria di metodo per visualizzare i singoli metodi che ne fanno parte.

6. Seleziona la scheda Tipi per visualizzare i tipi di API. I tipi non sono classificati e sono elencati in ordine alfabetico.

7. Seleziona il pulsante Menu principale per nascondere o mostrare il pannello di navigazione di Explorer API.

Visualizzazione della documentazione relativa al metodo e al tipo di API

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

1. Tutti i metodi che rientrano in quella categoria sono mostrati nel riquadro principale. Puoi scegliere di visualizzare tutti i metodi che sono nella categoria oppure puoi selezionare la scheda di un determinato tipo di metodo per filtrare l'elenco solo in base a quel tipo di metodo.

2. Per visualizzare la documentazione relativa a un metodo specifico, scegli il nome del metodo nel pannello di navigazione o seleziona il metodo nel riquadro principale.

Dopo aver selezionato un metodo specifico, Explorer API mostra la documentazione relativa a quel metodo.

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

Dichiarazioni di tipo e tipo

Explorer API esegue il rendering del metodo SDK e le dichiarazioni dei tipi nella lingua dell'SDK scelta nel menu a discesa del selettore lingua. Se il selettore della lingua dell'SDK è impostato su All, le dichiarazioni di metodi e tipi vengono mostrate in tutte le lingue supportate dell'SDK, separate da tabulazioni.

Esempi di SDK

Il repository sdk-codegen Looker ha una cartella che contiene esempi di SDK Looker. Se il repository sdk-codegen contiene esempi per un metodo, la pagina Explorer API del metodo mostrerà una sezione Esempi SDK con i link agli esempi.

Se viene selezionata una lingua specifica dell'SDK, i relativi esempi vengono elencati per primi.

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

Riferimenti

La sezione Riferimenti per ciascun metodo e tipo include i link alle pagine 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 chiamate API

Explorer API include un pulsante Esegui che apre un riquadro da cui puoi richiedere chiamate API e visualizzare le risposte in diversi formati supportati.

Quando selezioni il pulsante Esegui, Explorer API mostra una scheda Richiesta, in cui puoi inserire gli input per il metodo API.

Inserisci l'input desiderato e seleziona Esegui per eseguire la chiamata API.

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

Quando viene eseguita la richiesta, i risultati vengono visualizzati nella scheda Risposta.

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

Tipi di visualizzazione delle risposte

Le risposte di Explorer API includono un tipo MIME utilizzato per determinare come visualizzare i risultati.

CSV e altri dati tabulari

Per i dati CSV e JSON, Looker esegue un test di forma per determinare se i dati soddisfano i criteri di una tabella. Se Looker determina che i dati del payload sono tabulari, la visualizzazione predefinita per la risposta è una griglia di dati.

Seleziona la scheda Grezzo per visualizzare i dati non trasformati.

JSON

I payload JSON possono essere tabulari, nel qual caso verranno visualizzati in una griglia. Le intestazioni di colonna della query LookML vengono visualizzate nel formato <view_name>.<field_name> anziché nell'etichetta del campo.

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

PNG e JPEG

I formati PNG e JPEG mostrano la visualizzazione selezionata per la query e includono eventuali impostazioni di visualizzazione applicate. L'esempio successivo è l'output PNG della stessa query mostrata in precedenza ma utilizzando una visualizzazione tabella. JPEG viene gestito in modo simile.

SVG

Alcuni endpoint di Looker restituiscono il file SVG, anch'esso supportato direttamente. Di seguito è riportato un esempio dell'endpoint content_thumbnail in formato SVG, che restituisce un'immagine in miniatura astratta di una dashboard.

HTML

Le richieste che restituiscono un codice sorgente HTML mostrano l'HTML di origine nella scheda Risposta.

Testo

Le richieste che restituiscono SQL o altri formati con testo MIME visualizzato come testo normale vengono visualizzate come testo normale nella scheda Risposta.

Confronto tra le versioni dell'API

Explorer API include una pagina che ti consente di confrontare le diverse versioni dell'API Looker per vedere cosa è cambiato tra le versioni. Seleziona il pulsante triangolare Confronta specifiche, situato nell'angolo superiore destro della pagina, per aprire la pagina di confronto di Esplorazione API.

1. Seleziona la versione di base dell'API che vuoi confrontare con la versione di base.

2. Seleziona le opzioni API che vuoi includere nel confronto per filtrare i metodi solo in base a quelli che presentano differenze nelle opzioni selezionate. Le opzioni sono:

   • Mancante: mostra tutti i metodi che esistono in una versione dell'API e che non sono presenti nell'altra.
   • Stato: mostra tutti i metodi in cui lo stato del metodo è cambiato. Ad esempio, un metodo in cui lo stato è cambiato da beta a stable.
   • Parametri: mostra tutti i metodi in cui uno o più parametri dei metodi sono cambiati.
   • Tipo: mostra i tipi che hanno proprietà nuove, rimosse o modificate.
   • Corpo: mostra le modifiche ai parametri del corpo.
   • Risposta: mostra tutti i metodi in cui è stata apportata una modifica alla risposta del metodo.

3. La pagina di confronto mostra il numero di metodi in cui c'è una differenza ed elenca i metodi in cui c'è una differenza.

4. Seleziona un metodo per espanderlo e la pagina di confronto mostrerà una differenza che mostra come il metodo è cambiato tra le versioni.