Utilizzo di Explorer API

Explorer API di Looker è un'estensione, ovvero 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:

L'utente non deve accedere per la versione dell'estensione di API Explorer, perché API Explorer utilizza l'account dell'utente attivo per le richieste API. In questo modo, l'utente può 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 un altro utente per contribuire a diagnosticare i problemi di accesso.

Installazione di Explorer API

Explorer API è disponibile sul Marketplace di Looker.

Prima di installare API Explorer dal Marketplace, un amministratore di Looker deve attivare la funzionalità Extension Framework.

Per installare applicazioni, come l'estensione API Explorer, dal Marketplace devi disporre delle autorizzazioni develop, manage_models e deploy. Una volta installato Explorer API, qualsiasi utente con almeno l'autorizzazione access_data per il modello extension_api_explorer può utilizzarlo. Ogni utente può visualizzare tutti gli endpoint API in API Explorer, ma può eseguire solo quelli consentiti dalle sue autorizzazioni.

Se l'amministratore di Looker ha attivato l'opzione Installazione automatica nella pagina Marketplace della sezione Piattaforma del menu Amministrazione di Looker, Explorer API verrà installato automaticamente nella tua istanza. Inoltre, ogni volta che sono disponibili aggiornamenti, questi verranno applicati automaticamente, garantendo che la versione di API Explorer nella tua istanza sia la più recente.

Se l'amministratore di Looker non ha attivato l'opzione Installazione automatica, dovrai installare API Explorer dal marketplace di Looker.

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

Avvio di Explorer API

Una volta installato, puoi accedere a API Explorer dalla sezione Applicazioni della barra laterale sinistra.

Nella home page di API Explorer puoi eseguire le seguenti operazioni:

  1. Utilizza il menu a discesa per la selezione del linguaggio dell'SDK per scegliere il linguaggio di programmazione in cui l'Explorer API mostrerà le dichiarazioni di tipo e di metodo dell'API e i risultati del codice. Il selettore è impostato su Python per impostazione predefinita al caricamento iniziale. Se scegli Tutte dal selettore della lingua, API Explorer mostra una visualizzazione a schede per ogni lingua supportata.

  2. Utilizza il menu a discesa delle versioni per scegliere una versione dell'API:

    • 4.0 - attuale

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

  4. Inserisci un termine di ricerca nel campo Cerca per limitare i Metodi e i Tipi elencati solo a quelli che includono il 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 API. Puoi espandere o comprimere una categoria di metodi per visualizzare i singoli metodi della categoria.

  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 riquadro di navigazione di API Explorer.

Visualizzazione della documentazione del tipo e del metodo dell'API

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

  1. Tutti i metodi appartenenti a quella categoria vengono visualizzati nel riquadro principale. Puoi scegliere di visualizzare tutti i metodi della categoria oppure selezionare la scheda di un determinato tipo di metodo per filtrare l'elenco in base a quel tipo di metodo.

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

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

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

Dichiarazioni di metodi e tipi

API Explorer esegue il rendering delle dichiarazioni di tipo e del metodo dell'SDK nella lingua dell'SDK scelta nel menu a discesa del selettore della lingua dell'SDK. Se il selettore della lingua dell'SDK è impostato su Tutti, le dichiarazioni di metodi e tipi vengono visualizzate in tutti i linguaggi SDK supportati, separati da tabulazioni.

Esempi di SDK

Il repository sdk-codegen di Looker contiene una cartella con esempi di SDK Looker. Se il repository sdk-codegen contiene esempi per un metodo, nella pagina dell'esploratore API del metodo viene visualizzata una sezione Esempi 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 in Ruby e Java, anche se non sono linguaggi SDK.

Riferimenti

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

Utilizzo di Esegui per richiedere e visualizzare le chiamate API

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

Quando selezioni il pulsante Esegui, l'Explorer API mostra una scheda Richiesta in cui puoi fornire gli input al metodo dell'API.

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

Ogni volta che il metodo dell'API può modificare i dati (per qualsiasi chiamata REST che sia POST, PATCH, UPDATE o DELETE), viene visualizzata la casella di controllo di conferma della modifica dei dati, che deve essere selezionata 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 di chiamata dell'SDK scelto nel menu a discesa del selettore della lingua. Se il selettore della lingua dell'SDK è impostato su Tutti, la sintassi di chiamata 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 la modalità di visualizzazione dei 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 della risposta è una griglia di dati.

Seleziona la scheda Non elaborati per visualizzare i dati non trasformati.

JSON

I payload JSON possono essere tabulari, in questo caso verranno visualizzati in una griglia. Le intestazioni delle colonne per la query LookML vengono visualizzate nel formato <view_name>.<field_name> anziché nell'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 è l'output in formato PNG della stessa query mostrata in precedenza, ma utilizzando una visualizzazione tabella. I file JPEG vengono gestiti in modo simile.

Un esempio di download di file PNG.

SVG

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

Un esempio di download di file SVG.

HTML

Le richieste che restituiscono il codice sorgente HTML mostrano il codice sorgente HTML nella scheda Risposta.

Testo

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

Confronto tra le versioni dell'API

L'Explorer API include una pagina che ti consente di confrontare diverse versioni dell'API Looker per vedere cosa è cambiato tra una versione e l'altra. Seleziona il pulsante triangolare Confronta specifiche nell'angolo in alto a destra della pagina per aprire la pagina di confronto di API Explorer.

  1. Seleziona la versione base dell'API e la versione dell'API da confrontare con la versione base.

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

    • Mancanti: mostra tutti i metodi esistenti in una versione dell'API e mancanti nell'altra.
    • Stato: mostra tutti i metodi di cui è cambiato lo stato. Ad esempio, un metodo in cui lo stato è passato da beta a stable.
    • Parametri: mostra tutti i metodi in cui uno o più parametri del metodo sono stati modificati.
    • Tipo: mostra i tipi con proprietà nuove, rimosse o modificate.
    • Testo: mostra le modifiche ai parametri del testo.
    • 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 è presente una differenza e elenca i metodi in cui è presente una differenza.

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