Explorer API di Looker è un'estensione, un'applicazione web creata utilizzando componenti Looker, sviluppata utilizzando il framework di estensioni Looker e di cui è stato eseguito il deployment tramite Looker Marketplace.
Explorer API fornisce i seguenti asset:
- Documentazione per tutti i metodi e i tipi dell'API Looker
- Dichiarazioni relative a metodi e tipi in tutti i linguaggi degli SDK supportati
- Link a funzioni SDK di esempio che utilizzano metodi API
- Link alle pagine di Explorer API per metodi e tipi di riferimento
- Una funzione Eseguilo che ti consente di eseguire direttamente 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 acceda alla versione dell'estensione di API Explorer, poiché 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à di Looker sudo come un altro utente 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 in Looker Marketplace.
Prima di installare Explorer API da Marketplace, è necessario che un amministratore di Looker attivi la funzionalità Framework delle estensioni.
Per installare le applicazioni dal Marketplace, ad esempio l'estensione Explorer API, devi 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 Installazione automatica nella pagina Marketplace nella sezione Piattaforma del menu Amministrazione di Looker, Explorer API verrà installato automaticamente sulla tua istanza. Inoltre, ogni volta che sono disponibili aggiornamenti, questi verranno applicati automaticamente, garantendo che la versione di Explorer API sulla tua istanza sia la più recente.
Se l'amministratore di Looker non ha abilitato l'opzione Installazione automatica, dovrai installare Explorer API da Looker Marketplace.
Per le 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, accedi a Looker Marketplace, seleziona Gestisci e seleziona il pulsante Aggiorna accanto all'estensione.
Avvio di Explorer API
Una volta installato Explorer API, puoi accedervi dalla sezione Applicazioni della barra laterale sinistra.
Navigazione in Explorer API
Nella home page di Explorer API puoi eseguire le seguenti attività:
Utilizza il menu a discesa del selettore del linguaggio dell'SDK per scegliere il linguaggio di programmazione in cui Explorer API mostrerà le dichiarazioni del metodo e del tipo API e i risultati del codice. Al caricamento iniziale, il selettore utilizza il linguaggio Python per impostazione predefinita. Se scegli Tutte nel selettore della lingua, Explorer API mostrerà una visualizzazione a schede per ogni lingua supportata.
Utilizza il menu a discesa della versione per scegliere una versione dell'API:
- 4,0 - attuale
Seleziona il pulsante Confronta le specifiche per aprire la pagina di confronto delle versioni dell'API.
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 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 API. Puoi espandere o comprimere una categoria di metodi per visualizzare i singoli metodi nella categoria.
Seleziona la scheda Tipi per visualizzare i tipi di API. I tipi non sono classificati e sono elencati in ordine alfabetico.
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, questa si espande e mostra tutti i metodi presenti in quella categoria.
Tutti i metodi inclusi in quella categoria vengono mostrati nel riquadro principale. Puoi scegliere di visualizzare tutti i metodi della categoria oppure puoi selezionare la scheda per un determinato tipo di metodo per filtrare l'elenco in base a quel tipo.
Per visualizzare la documentazione relativa a un metodo specifico, scegli il nome del metodo nel pannello di navigazione oppure seleziona il metodo nel riquadro principale.
Dopo aver selezionato un metodo specifico, Explorer API visualizza la documentazione corrispondente.
Quando selezioni un tipo dalla scheda Tipo, la documentazione relativa a quel tipo viene visualizzata nel riquadro principale.
Dichiarazioni di metodo e tipo
Explorer API esegue il rendering delle dichiarazioni del metodo e del tipo SDK nel linguaggio SDK scelto nel menu a discesa del selettore della lingua dell'SDK. Se il selettore della lingua dell'SDK è impostato su Tutte, le dichiarazioni relative a metodo e tipo vengono visualizzate in tutte le lingue dell'SDK supportate, separate da schede.
Esempi di SDK
Il repository sdk-codegen di Looker contiene una cartella contenente esempi dell'SDK di Looker. Se il repository sdk-codegen contiene esempi per un metodo, la pagina Explorer API del metodo mostrerà una sezione Esempi di SDK con i link agli esempi.
Se è selezionata una lingua SDK specifica, gli esempi per quella lingua vengono elencati per primi.
Potrebbero essere visualizzati anche esempi Ruby e Java, anche se questi non sono linguaggi SDK.
Riferimenti
La sezione Riferimenti per ogni metodo e tipo include link alle pagine di Explorer API relative a ogni metodo o tipo a cui viene fatto riferimento dal metodo o tipo originale.
Utilizzo di Run It per richiedere e visualizzare le chiamate API
Explorer API include un pulsante Eseguilo che apre un riquadro in cui è possibile richiedere chiamate API e visualizzare le risposte in una varietà di formati supportati.
Quando selezioni il pulsante Eseguilo, Explorer API mostra una scheda Richiesta, in cui puoi fornire gli input al 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 sia
POST,PATCH,UPDATEoDELETE), viene visualizzata la casella di controllo di conferma della modifica dei dati che deve essere selezionata prima di poter eseguire la richiesta.
Quando la richiesta viene eseguita, la scheda Risposta mostra i risultati.
Inoltre, nella scheda Codice viene mostrata la sintassi della chiamata SDK per l'SDK che viene scelta nel menu a discesa del selettore della lingua. Se il selettore della lingua dell'SDK è impostato su Tutte, la sintassi delle chiamate SDK viene visualizzata in tutte le lingue supportate dall'SDK, separate da schede.
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 Raw (Non elaborati) 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 per la query LookML vengono visualizzate nel formato <view_name>.<field_name>, anziché nell'etichetta del campo.
I payload JSON complessi omettono la visualizzazione 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 le eventuali impostazioni di visualizzazione applicate. L'esempio successivo è l'output in formato PNG della stessa query mostrata in precedenza, ma utilizzando una visualizzazione tabulare. Il formato JPEG è 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, che restituisce un'immagine in miniatura astratta di una dashboard.
HTML
Le richieste che restituiscono il codice sorgente HTML mostrano l'HTML sorgente nella scheda Risposta.
Testo
Le richieste che restituiscono formati SQL o altri formati digitati MIME 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 diverse versioni dell'API Looker per vedere cosa è cambiato da una versione all'altra. Seleziona il pulsante triangolare Confronta le specifiche, situato nell'angolo in alto a destra della pagina, per aprire la pagina di confronto di Explorer API.
Seleziona la versione di base dell'API e quella da confrontare con la versione di base.
Seleziona le opzioni API da includere nel confronto per filtrare i metodi e visualizzare solo quelli che presentano differenze nelle opzioni selezionate. Le opzioni sono:
- Mancante: mostra tutti i metodi esistenti in una versione dell'API e mancanti nell'altra.
- Stato: mostra tutti i metodi in cui lo stato del metodo è stato modificato. Ad esempio, un metodo in cui lo stato è cambiato da
betaastable. - Parametri: mostra tutti i metodi in cui uno o più parametri sono stati modificati.
- Tipo: mostra i tipi con proprietà nuove, rimosse o modificate.
- Corpo: mostra le modifiche apportate ai parametri del corpo.
- Risposta: mostra tutti i metodi in cui è stata apportata una modifica nella risposta del metodo.
Nella pagina di confronto viene indicato il numero di metodi in cui esiste una differenza e altri metodi.
Seleziona un metodo per espanderlo e la pagina di confronto mostra una differenza che mostra come il metodo è cambiato tra le versioni.