Der Looker API Explorer ist eine Erweiterung – eine Webanwendung, die mit Looker-Komponenten erstellt wird –, die mit dem Looker-Extension Framework entwickelt und über den Looker Marketplace bereitgestellt wird.
Der API Explorer bietet die folgenden Assets zur Verwendung mit der Looker API:
- Dokumentation zu allen Looker API-Methoden und ‑Typen
- Methoden- und Typdeklarationen in allen unterstützten SDK-Sprachen
- Links zu Beispiel-SDK-Funktionen, die API-Methoden verwenden
- Links zu API Explorer-Seiten für aufgerufene Methoden und Typen
- Eine Run It-Funktion, mit der Sie API-Aufrufe direkt ausführen können und die den Code für die API-Aufrufe, API-Antworten und SDK-Funktionen liefert
- Ein Vergleichstool, das die Unterschiede zwischen den Looker API-Versionen zeigt
Für die Erweiterungsversion von API Explorer muss sich der Nutzer nicht anmelden, da API Explorer das Konto des aktiven Nutzers für API-Anfragen verwendet. So kann der Nutzer nur die API-Aufrufe ausführen, zu denen er berechtigt ist, und muss keine API-Anmeldedaten angeben.
Mit der Funktion sudo als anderer Nutzer in Looker können Sie auch API-Anfragen als anderer Nutzer stellen, um Zugriffsprobleme zu diagnostizieren.
API Explorer installieren
Der API Explorer ist im Looker Marketplace verfügbar.
Bevor Sie den API Explorer über den Marketplace installieren, muss ein Looker-Administrator die Funktion Extension Framework aktivieren.
Wenn Sie Anwendungen wie die API Explorer-Erweiterung aus dem Marketplace installieren möchten, benötigen Sie die Berechtigungen develop, manage_models und deploy. Sobald der API Explorer installiert ist, kann jeder Nutzer mit mindestens der Berechtigung access_data für das extension_api_explorer-Modell ihn verwenden. Jeder Nutzer kann alle API-Endpunkte im API Explorer aufrufen, aber nur die ausführen, die durch seine Berechtigungen zulässig sind.
Wenn Ihr Looker-Administrator die Option Automatische Installation auf der Seite Marketplace im Bereich Plattform des Menüs Verwaltung aktiviert hat, wird der API Explorer automatisch in Ihrer Instanz installiert. Außerdem werden alle verfügbaren Updates automatisch angewendet, damit die API Explorer-Version in Ihrer Instanz immer auf dem neuesten Stand ist.
Wenn Ihr Looker-Administrator die Option Automatische Installation nicht aktiviert hat, müssen Sie den API Explorer aus dem Looker Marketplace installieren.
Auf der Dokumentationsseite Looker Marketplace verwenden finden Sie eine Anleitung zum Installieren einer Erweiterung aus dem Looker Marketplace. Sie können dafür sorgen, dass Sie immer die neueste Version des API Explorer haben, indem Sie den Looker Marketplace aufrufen, Verwalten auswählen und neben der Erweiterung die Schaltfläche Aktualisieren anklicken.
API Explorer starten
Sobald der API Explorer installiert ist, können Sie ihn in der linken Seitenleiste im Bereich Applications (Anwendungen) aufrufen.
Im API Explorer navigieren
Auf der API Explorer-Startseite können Sie die folgenden Aufgaben ausführen:
Wählen Sie im Drop-down-Menü für die SDK-Sprachauswahl die Programmiersprache aus, in der API Explorer API-Methoden- und -Typdeklarationen sowie Codeergebnisse anzeigen soll. Bei der Erstausführung ist standardmäßig Python ausgewählt. Wenn Sie in der Sprachauswahl Alle auswählen, zeigt der API Explorer für jede unterstützte Sprache eine Ansicht mit Tabs an.
Wählen Sie im Drop-down-Menü „Version“ eine Version der API aus:
- 4,0 – aktuell
Klicken Sie auf die Schaltfläche Vergleich der Spezifikationen, um die Seite zum Vergleich der API-Versionen zu öffnen.
Geben Sie in das Feld Suchen einen Suchbegriff ein, um die aufgeführten Methoden und Typen auf diejenigen zu beschränken, die Text enthalten, der mit dem Suchbegriff übereinstimmt.
Wenn Sie eine von der Suche zurückgegebene Methode oder einen Typ auswählen, wird der Suchbegriff in der Zusammenfassung der Methode oder des Typs hervorgehoben.
Wählen Sie den Tab Methoden aus, um Kategorien für API-Methoden aufzurufen. Sie können eine Methodenkategorie maximieren oder minimieren, um die einzelnen Methoden in der Kategorie anzuzeigen.
Wählen Sie den Tab Typen aus, um API-Typen aufzurufen. Die Typen sind nicht kategorisiert und werden in alphabetischer Reihenfolge aufgeführt.
Klicken Sie auf die Schaltfläche Hauptmenü, um den API Explorer-Navigationsbereich ein- oder auszublenden.
Dokumentation zu API-Methoden und -Typen ansehen
Wenn Sie auf dem Tab Methode eine Methodenkategorie auswählen, wird die Methodenkategorie erweitert und Sie sehen alle Methoden aus dieser Kategorie.
Alle Methoden in dieser Kategorie werden im Hauptbereich angezeigt. Sie können alle Methoden aus der Kategorie anzeigen lassen oder den Tab für einen bestimmten Methodentyp auswählen, um die Liste nach diesem Methodentyp zu filtern.
Wenn Sie die Dokumentation für eine bestimmte Methode aufrufen möchten, wählen Sie entweder den Methodennamen im Navigationsbereich oder die Methode im Hauptbereich aus.
Nachdem Sie eine bestimmte Methode ausgewählt haben, wird in API Explorer die Dokumentation für diese Methode angezeigt.
Wenn Sie auf dem Tab Typ einen Typ auswählen, wird die Dokumentation für diesen Typ im Hauptsteuerfeld angezeigt.
Methoden- und Typdeklarationen
Im API Explorer werden die SDK-Methoden- und -Typdeklarationen in der SDK-Sprache gerendert, die im Drop-down-Menü „SDK-Sprache“ ausgewählt wurde. Wenn die SDK-Sprachauswahl auf All gesetzt ist, werden die Methoden- und Typdeklarationen in allen unterstützten SDK-Sprachen angezeigt, getrennt durch Tabulatoren.
SDK-Beispiele
Das Looker-Repository sdk-codegen enthält einen Ordner mit Beispielen für das Looker SDK. Wenn das sdk-codegen-Repository Beispiele für eine Methode enthält, wird auf der API Explorer-Seite der Methode der Abschnitt SDK-Beispiele mit Links zu den Beispielen angezeigt.
Wenn eine bestimmte SDK-Sprache ausgewählt ist, werden Beispiele für diese Sprache zuerst aufgeführt.
Möglicherweise werden auch Ruby- und Java-Beispiele angezeigt, obwohl dies keine SDK-Sprachen sind.
Verweise
Der Abschnitt Referenzen für jede Methode und jeden Typ enthält Links zu den API Explorer-Seiten für jede Methode und jeden Typ, auf die bzw. den die ursprüngliche Methode oder der ursprüngliche Typ verwiesen wird.
Mit Run It API-Aufrufe anfordern und anzeigen
Der API Explorer enthält die Schaltfläche Run It (Ausführen), über die Sie API-Aufrufe anfordern und die Antworten in verschiedenen unterstützten Formaten anzeigen können.
Wenn Sie die Schaltfläche Ausführen auswählen, wird im API Explorer der Tab Anfrage angezeigt, auf dem Sie die Eingaben für die API-Methode angeben können.
Geben Sie die gewünschte Eingabe ein und wählen Sie Ausführen aus, um den API-Aufruf auszuführen.
Immer wenn die API-Methode Daten ändern kann (bei jedem REST-Aufruf, der
POST,PATCH,UPDATEoderDELETEist), wird das Kästchen zur Bestätigung der Datenänderung angezeigt. Dieses Kästchen muss angeklickt werden, bevor die Anfrage ausgeführt werden kann.
Wenn die Anfrage ausgeführt wird, werden die Ergebnisse auf dem Tab Antwort angezeigt.
Außerdem wird auf dem Tab Code die SDK-Aufrufsyntax für das SDK angezeigt, die im Drop-down-Menü für die Sprachauswahl ausgewählt ist. Wenn die SDK-Sprachauswahl auf Alle gesetzt ist, wird die SDK-Aufrufsyntax in allen unterstützten SDK-Sprachen angezeigt, getrennt durch Tabs.
Antwortanzeigetypen
API Explorer-Antworten enthalten einen MIME-Typ, mit dem festgelegt wird, wie die Ergebnisse angezeigt werden.
CSV und andere tabellarische Daten
Für CSV- und JSON-Daten führt Looker einen Formtest durch, um festzustellen, ob die Daten die Kriterien einer Tabelle erfüllen. Wenn Looker feststellt, dass die Nutzlastdaten tabellarisch sind, ist die Standardanzeige für die Antwort ein Datenraster.
Wählen Sie den Tab Rohdaten aus, um die nicht transformierten Daten anzuzeigen.
JSON
JSON-Nutzlasten können tabellarisch sein. In diesem Fall werden sie in einem Raster angezeigt. Die Spaltenüberschriften für die LookML-Abfrage werden im Format <view_name>.<field_name> angezeigt, anstatt das Label des Felds zu zeigen.
Bei komplexen JSON-Nutzlasten wird die Rasteranzeige weggelassen und nur die Roh-JSON angezeigt.
PNG und JPEG
Die PNG- und JPEG-Formate enthalten die für die Abfrage ausgewählte Visualisierung und alle angewendeten Visualisierungseinstellungen. Das nächste Beispiel ist eine PNG-Ausgabe der gleichen Abfrage, die zuvor gezeigt wurde, jedoch unter Verwendung einer Tabellenvisualisierung. JPEG-Dateien werden ähnlich behandelt.
SVG
Einige Looker-Endpunkte geben SVG zurück, was ebenfalls direkt unterstützt wird. Im Folgenden finden Sie ein Beispiel für den content_thumbnail-Endpunkt im SVG-Format, der eine abstrakte Miniaturansicht eines Dashboards zurückgibt.
HTML
Für Anfragen, die HTML-Quellcode zurückgeben, wird der HTML-Quellcode auf dem Tab Antwort angezeigt.
Text
Anfragen, die SQL oder andere Formate zurückgeben, die als MIME-Texttyp angegeben sind, werden auf dem Tab Antwort als Nur-Text angezeigt.
API-Versionen vergleichen
Der API Explorer enthält eine Seite, auf der Sie verschiedene Versionen der Looker-API vergleichen können, um zu sehen, was sich zwischen den Versionen geändert hat. Klicken Sie oben rechts auf der Seite auf die dreieckige Schaltfläche Spezifikationen vergleichen, um die Vergleichsseite des API Explorers zu öffnen.
Wählen Sie die Basisversion der API und die Version der API aus, die Sie mit der Basisversion vergleichen möchten.
Wählen Sie die API-Optionen aus, die im Vergleich berücksichtigt werden sollen, um die Methoden so zu filtern, dass nur diejenigen angezeigt werden, bei denen sich die ausgewählten Optionen unterscheiden. Folgende Optionen sind verfügbar:
- Fehlt: Zeigt alle Methoden an, die in der einen Version der API vorhanden sind und in der anderen fehlen.
- Status: Hier werden alle Methoden angezeigt, bei denen sich der Methodenstatus geändert hat. Beispiel: Eine Methode, bei der sich der Status von
betainstablegeändert hat. - Parameter: Zeigt alle Methoden an, bei denen sich mindestens ein Methodenparameter geändert hat.
- Typ: Hier werden Typen angezeigt, die neue, entfernte oder geänderte Eigenschaften haben.
- Text – zeigt Änderungen an Textparametern an.
- Antwort: Hier werden alle Methoden angezeigt, bei denen sich die Methodenantwort geändert hat.
Auf der Vergleichsseite sehen Sie die Anzahl der Methoden, bei denen es einen Unterschied gibt, und die Methoden, bei denen es einen Unterschied gibt.
Wenn Sie eine Methode auswählen, um sie zu maximieren, sehen Sie auf der Vergleichsseite einen Unterschied, aus dem hervorgeht, wie sich die Methode zwischen den Versionen geändert hat.