Explorer API di Looker è un'estensione, un'applicazione web creata utilizzando i componenti di Looker, sviluppata utilizzando il framework di estensioni di Looker e di cui viene eseguito il deployment tramite Looker Marketplace.
Explorer API fornisce i seguenti asset da utilizzare con l'API Looker:
- Documentazione per tutti i metodi e i tipi dell'API Looker
- Dichiarazioni relative a metodo e tipo in tutte le lingue dell'SDK supportate
- Link alle funzioni dell'SDK di esempio che utilizzano metodi API
- Link alle pagine di Explorer API per metodi e tipi di riferimento
- Una funzione Esegui che ti 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 tra le versioni dell'API Looker
Non è necessario che l'utente acceda per la versione di 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 credenziali API.
La funzionalità sudo come altro utente di Looker può essere utilizzata anche per effettuare richieste API come un utente diverso al fine di diagnosticare i problemi di accesso.
Installazione di Explorer API
Explorer API è disponibile nel Marketplace di Looker.
Prima di installare Explorer API da Marketplace, un amministratore di Looker deve abilitare la funzionalità Framework estensione.
Per installare applicazioni da 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 dalle proprie autorizzazioni.
Se l'amministratore di Looker ha abilitato l'opzione Installazione automatica nella pagina Marketplace nella sezione Piattaforma del menu Amministratore di Looker, Explorer API verrà installato automaticamente sulla tua istanza. Inoltre, ogni volta che sono disponibili degli 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, 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 disporre sempre della versione più aggiornata di Explorer API, accedi a Looker Marketplace, seleziona Gestisci e poi il pulsante Aggiorna accanto all'estensione.
Avvio di Explorer API
Una volta installato Explorer API, puoi accedervi dalla sezione Applications (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 Python per impostazione predefinita. Se scegli Tutte dal selettore della lingua, Explorer API mostra 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 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.
Seleziona la scheda Metodi per visualizzare le categorie dei metodi API. Puoi espandere o comprimere una categoria di metodi per visualizzare i singoli metodi al suo interno.
Seleziona la scheda Tipi per visualizzare i tipi di API. I tipi non sono categorizzati 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 sul metodo e sul tipo di API
Quando selezioni una categoria di metodo nella scheda Metodo, la categoria di metodo si espande e mostra tutti i metodi che fanno parte della categoria in questione.
Tutti i metodi presenti in quella categoria sono mostrati nel riquadro principale. Puoi scegliere di visualizzare tutti i metodi presenti nella categoria oppure selezionare la scheda di un determinato tipo di metodo per filtrare l'elenco in base a quel determinato tipo.
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 per quel metodo.
Quando selezioni un tipo dalla scheda Tipo, la relativa documentazione viene visualizzata nel riquadro principale.
Dichiarazioni di metodo e tipo
Explorer API mostra le dichiarazioni del tipo e del metodo SDK nel linguaggio SDK scelto nel menu a discesa del selettore della lingua dell'SDK. Se il selettore della lingua dell'SDK è impostato su Tutti, le dichiarazioni di metodo e tipo vengono visualizzate in tutte le lingue dell'SDK supportate, separate da schede.
Esempi di SDK
Il repository sdk-codegen di 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 mostra una sezione Esempi di SDK con i link agli esempi.
Se viene selezionata una lingua specifica dell'SDK, vengono elencati per primi gli esempi per quella lingua.
Potrebbero essere visualizzati anche esempi di Ruby e Java, anche se non si tratta di linguaggi SDK.
Riferimenti
La sezione Riferimenti per ogni metodo e tipo include link alle pagine di esplorazione 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 Esegui che apre un riquadro da cui puoi richiedere le chiamate API e visualizzare le risposte in una varietà di formati supportati.
Quando selezioni il pulsante Esegui, Explorer API mostra una scheda Richiesta in cui puoi fornire 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 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.
Una volta eseguita la richiesta, la scheda Risposta mostra i risultati.
Inoltre, la scheda Codice mostra la sintassi della chiamata all'SDK per l'SDK scelto nel menu a discesa del selettore della lingua. Se il selettore della lingua dell'SDK è impostato su Tutti, la sintassi della chiamata dell'SDK viene visualizzata in tutte le lingue dell'SDK supportate, separate da schede.
Tipi di visualizzazione della risposta
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 per visualizzare i dati non trasformati.
JSON
I payload JSON possono essere tabulari e in questo caso verranno visualizzati in una griglia. Le intestazioni di colonna per la query LookML vengono visualizzate nel formato <view_name>.<field_name>, anziché visualizzare l'etichetta del campo.
I payload JSON complessi omettono la visualizzazione 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 è un output PNG della stessa query mostrata in precedenza, ma utilizzando una visualizzazione tabella. JPEG viene gestito in modo simile.
SVG
Alcuni endpoint Looker restituiscono 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 visualizzano l'HTML sorgente nella scheda Risposta.
Testo
Le richieste che restituiscono SQL o altri formati digitati MIME come testo normale vengono visualizzate come testo normale nella scheda Risposta.
Confronto tra le versioni delle API
Explorer API include una pagina che ti consente di confrontare le 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 la versione dell'API da confrontare con la versione di base.
Seleziona le opzioni dell'API da includere nel confronto per filtrare i metodi solo per 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 è cambiato. Ad esempio, un metodo in cui lo stato è cambiato da
betaastable. - Parametri: mostra tutti i metodi in cui uno o più parametri dei metodi sono stati modificati.
- Tipo: mostra i tipi con proprietà nuove, rimosse o modificate.
- Corpo: mostra le modifiche ai parametri del corpo.
- Risposta: mostra tutti i metodi in cui è stata rilevata una modifica nella risposta del metodo.
La pagina di confronto mostra il numero di metodi in cui esiste una differenza ed elenca quelli in cui esiste una differenza.
Seleziona un metodo per espanderlo e la pagina di confronto mostrerà una differenza che mostra le modifiche del metodo tra le versioni.