API Explorer verwenden

Hinweis: Ab Looker 22.4 ist die Looker API 4.0 allgemein verfügbar. In Looker 23.18 wurde die Looker API 3.1 entfernt.

Der Looker API Explorer ist eine Erweiterung – eine Webanwendung, die mit Looker-Komponenten erstellt wird. Sie wurde mit dem Erweiterungs-Framework von Looker entwickelt und über den Looker Marketplace bereitgestellt.

Der API Explorer bietet die folgenden Assets zur Verwendung mit der Looker API:

• Dokumentation für alle 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 aufzeigt.

Der Nutzer muss sich nicht für die Erweiterungsversion von API Explorer anmelden, da API Explorer das aktive Nutzerkonto für API-Anfragen verwendet. Dadurch wird sichergestellt, dass der Nutzer nur die API-Aufrufe ausführen kann, für die er berechtigt ist. Gleichzeitig müssen Nutzer keine API-Anmeldedaten angeben.

Mit der Looker-Funktion sudo as other user 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.

Für die Installation von Anwendungen wie der API Explorer-Erweiterung aus dem Marketplace sind die Berechtigungen develop, manage_models und deploy erforderlich. 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 zwar alle API-Endpunkte im API Explorer ansehen, kann aber nur diejenigen ausführen, die aufgrund seiner Berechtigungen zulässig sind.

Wenn Ihr Looker-Administrator im Looker-Menü Admin auf der Seite Marketplace im Bereich Plattform die Option Automatisch installieren aktiviert hat, wird API Explorer automatisch auf Ihrer Instanz installiert. Außerdem werden alle Updates, die verfügbar sind, automatisch angewendet. So wird sichergestellt, dass die API Explorer-Version auf Ihrer Instanz auf dem neuesten Stand ist.

Falls der Looker-Administrator die Option Automatisch installieren 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 Explorers verwenden. Rufen Sie dazu den Looker Marketplace auf, wählen Sie Verwalten und dann neben der Erweiterung die Schaltfläche Aktualisieren aus.

Hinweis: Wenn Sie den API Explorer auf einer vom Kunden gehosteten Looker-Instanz installieren, muss der Server, auf dem die Looker-Instanz ausgeführt wird, für den Zugriff auf den öffentlichen Internetserver konfiguriert sein, der unter der URL https://githubusercontent.com ausgeführt wird, damit Nutzer sich API-Beispiele ansehen können.

API Explorer starten

Sobald der API Explorer installiert ist, können Sie ihn in der linken Seitenleiste im Bereich Applications (Anwendungen) aufrufen.

Hinweis: Looker-Administratoren können auch auf den API Explorer zugreifen, indem Sie auf der Looker-Seite API-Verwaltung den Link API Explorer verwenden auswählen.

Im API Explorer navigieren

Auf der API Explorer-Startseite können Sie die folgenden Aufgaben ausführen:

1. Wählen Sie in der Drop-down-Liste für die SDK-Sprachauswahl die Programmiersprache aus, in der API Explorer API-Methoden- und -Typdeklarationen sowie Codeergebnisse anzeigen soll. Die Auswahl wird beim ersten Laden standardmäßig auf Python gesetzt. Wenn Sie in der Sprachauswahl Alle auswählen, zeigt der API Explorer für jede unterstützte Sprache eine Ansicht mit Tabs an.

2. Wählen Sie im Drop-down-Menü „Version“ eine Version der API aus:

   • 4,0 – aktuell

3. Klicken Sie auf die Schaltfläche Vergleich der Spezifikationen, um die Seite zum Vergleich der API-Versionen zu öffnen.

4. 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 Ihrem Suchbegriff übereinstimmt.

   

   Wenn Sie eine Methode oder einen Typ auswählen, die bzw. der von der Suche zurückgegeben wird, wird der Suchbegriff in der Methoden- oder Typzusammenfassung hervorgehoben.

5. Wählen Sie den Tab Methoden aus, um die Kategorien der API-Methoden aufzurufen. Sie können eine Methodenkategorie maximieren oder minimieren, um die einzelnen Methoden in der Kategorie anzuzeigen.

6. Wählen Sie den Tab Typen aus, um API-Typen aufzurufen. Typen sind nicht kategorisiert und in alphabetischer Reihenfolge aufgelistet.

7. 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.

1. 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.

2. Um die Dokumentation für eine bestimmte Methode aufzurufen, wählen Sie entweder den Methodennamen im Navigationsbereich oder die Methode im Hauptbereich aus.

Nachdem Sie eine bestimmte Methode ausgewählt haben, zeigt API Explorer die Dokumentation für diese Methode an.

Wenn Sie auf dem Tab Typ einen Typ auswählen, wird die Dokumentation für diesen Typ im Hauptsteuerfeld angezeigt.

Methoden- und Typdeklarationen

API Explorer rendert die SDK-Methode und -Typdeklarationen in der SDK-Sprache, die im Drop-down-Menü für die SDK-Sprachauswahl ausgewählt ist. 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 sdk-codegen-Repository von Looker enthält einen Ordner mit Looker SDK-Beispielen. 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.

Es können auch Ruby- und Java-Beispiele angezeigt werden, 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 auf die Schaltfläche Run It (Ausführen) klicken, wird im API Explorer der Tab Request 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, UPDATE oder DELETE ist), 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 auf dem Tab Response (Antwort) die Ergebnisse 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.

Anzeigetypen für Antworten

API Explorer-Antworten enthalten einen MIME-Typ, mit dem festgelegt wird, wie die Ergebnisse angezeigt werden.

CSV und andere tabellarische Daten

Bei 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> anstelle der Bezeichnung des Felds angezeigt.

Komplexe JSON-Nutzlasten lassen die Rasteranzeige aus und zeigen nur die JSON-Rohdaten an.

PNG und JPEG

Die Formate PNG und JPEG zeigen die für die Abfrage ausgewählte Visualisierung an und schließen alle angewendeten Visualisierungseinstellungen ein. 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-Datei

Einige Looker-Endpunkte geben SVG zurück, das ebenfalls direkt unterstützt wird. Das folgende Beispiel zeigt den Endpunkt content_thumbnail im SVG-Format, bei dem eine abstrahierte Miniaturansicht eines Dashboards zurückgegeben wird.

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 Nur-Text als MIME-Typ eingegeben wurden, 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 die dreieckige Schaltfläche Spezifikationen vergleichen, um die Vergleichsseite des API Explorers zu öffnen.

1. Wählen Sie die Basisversion der API und die API-Version aus, die Sie mit der Basisversion vergleichen möchten.

2. 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: Zeigt alle Methoden an, bei denen sich der Methodenstatus geändert hat. Zum Beispiel eine Methode, bei der sich der Status von beta in stable geä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: Zeigt alle Methoden an, bei denen es eine Änderung in der Methodenantwort gab.

3. Auf der Vergleichsseite sehen Sie die Anzahl der Methoden, bei denen es einen Unterschied gibt, und die Methoden, bei denen es einen Unterschied gibt.

4. 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.