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 auf Looker-Komponenten basiert. Sie wurde mit dem Erweiterungs-Framework von Looker entwickelt und über den Looker Marketplace bereitgestellt.

Der API Explorer stellt die folgenden Assets zur Verfügung:

• 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 Referenzmethoden 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 bereitstellt
• Ein Vergleichstool, das die Unterschiede zwischen den Looker API-Versionen zeigt

Der Nutzer muss sich bei der Erweiterungsversion von API Explorer nicht anmelden, da API Explorer das Konto des aktiven Nutzers für API-Anfragen verwendet. Dadurch wird sichergestellt, dass der Nutzer nur die API-Aufrufe ausführen kann, für die er berechtigt ist, und gleichzeitig die Notwendigkeit für die Angabe von API-Anmeldedaten entfällt.

Die Funktion sudo as other user von Looker kann auch verwendet werden, um API-Anfragen als ein anderer Nutzer zu senden und so Zugriffsprobleme zu diagnostizieren.

API Explorer installieren

Der API Explorer ist im Looker Marketplace verfügbar.

Bevor der API Explorer aus dem Marketplace installiert wird, muss ein Looker-Administrator das Extension Framework aktivieren.

Zum Installieren von Anwendungen wie der API Explorer-Erweiterung aus dem Marketplace benötigen Sie die Berechtigungen develop, manage_models und deploy. Nach der Installation von API Explorer kann jeder Nutzer mit mindestens der Berechtigung access_data für das Modell extension_api_explorer den API Explorer verwenden. Jeder Nutzer kann alle API-Endpunkte im API Explorer ansehen, aber nur die ausführen, die durch seine Berechtigungen zugelassen sind.

Wenn Ihr Looker-Administrator im Looker-Menü Admin im Abschnitt Plattform auf der Seite Marketplace die Option Automatische Installation aktiviert hat, wird API Explorer automatisch auf Ihrer Instanz installiert. Außerdem werden alle verfügbaren Updates automatisch angewendet, um sicherzustellen, dass die Version des API Explorers auf Ihrer Instanz 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.

Eine Anleitung zum Installieren einer Erweiterung aus dem Looker Marketplace finden Sie auf der Dokumentationsseite Looker Marketplace verwenden. Wenn Sie immer die neueste Version des API Explorers verwenden, rufen Sie den Looker Marketplace auf, wählen Sie Verwalten aus und klicken Sie neben der Erweiterung auf die Schaltfläche Aktualisieren.

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 API-Beispiele ansehen können.

API Explorer starten

Sobald der API Explorer installiert ist, können Sie ihn über den Abschnitt Applications (Anwendungen) in der linken Seitenleiste aufrufen.

Hinweis :Als Looker-Administrator können Sie auch über den Link API Explorer verwenden auf der API-Admin-Seite von Looker auf den API Explorer zugreifen.

Im API Explorer navigieren

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

1. 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 anzeigt. Die Auswahl ist beim anfänglichen Laden standardmäßig auf Python eingestellt. Wenn Sie in der Sprachauswahl Alle auswählen, zeigt API Explorer jede unterstützte Sprache in einer Tab-Ansicht an.

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

   • 4,0 – aktuell

3. Wählen Sie die Schaltfläche Vergleichen aus, um die Seite Vergleich der API-Versionen zu öffnen.

4. Geben Sie einen Suchbegriff in das Feld Suchen ein, um die aufgeführten Methoden und Typen auf diejenigen zu beschränken, die Text enthalten, der dem Suchbegriff entspricht.

   

   Wenn Sie eine Methode oder einen Typ auswählen, der 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 von API-Methoden aufzurufen. Sie können eine Methodenkategorie erweitern oder reduzieren, um die einzelnen Methoden in der Kategorie anzuzeigen.

6. Wählen Sie den Tab Typen aus, um die API-Typen aufzurufen. Typen werden nicht kategorisiert und sind in alphabetischer Reihenfolge aufgeführt.

7. Klicken Sie auf die Schaltfläche Hauptmenü, um den Navigationsbereich von API Explorer ein- oder auszublenden.

Dokumentation zu API-Methoden und -Typen ansehen

Wenn Sie auf dem Tab Methode eine Methodenkategorie auswählen, wird die Kategorie der Methoden erweitert und alle Methoden in dieser Kategorie werden angezeigt.

1. Alle Methoden, die zu dieser Kategorie gehören, werden im Hauptsteuerfeld angezeigt. Sie können alle Methoden in der Kategorie anzeigen lassen oder den Tab für einen bestimmten Methodentyp auswählen, um die Liste nach diesem Methodentyp zu filtern.

2. Wenn Sie die Dokumentation für eine bestimmte Methode anzeigen möchten, wählen Sie entweder im Navigationsbereich den Methodennamen oder die Methode im Hauptbereich aus.

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

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

Methoden- und Typdeklarationen

API Explorer rendert die SDK-Methoden- und -Typdeklarationen in der SDK-Sprache, die im Drop-down-Menü für die SDK-Sprachauswahl ausgewählt ist. Wenn die SDK-Sprachauswahl auf Alle gesetzt ist, werden die Methoden- und Typdeklarationen in allen unterstützten SDK-Sprachen durch Tabs getrennt angezeigt.

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 wird, werden die Beispiele für diese Sprache zuerst aufgeführt.

Es können auch Beispiele für Ruby und Java angezeigt werden, allerdings sind dies keine SDK-Sprachen.

Verweise

Der Abschnitt Referenzen für jede Methode und jeden Typ enthält Links zu den API Explorer-Seiten für jede Methode oder jeden Typ, auf die die ursprüngliche Methode oder den ursprünglichen Typ verweist.

API-Aufrufe mit „Run It“ anfordern und anzeigen lassen

Der API Explorer enthält die Schaltfläche Ausführen, über die Sie einen Bereich aufrufen können, über den Sie API-Aufrufe anfordern und die Antworten in einer Vielzahl von 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 mit der API-Methode Daten geändert werden können (bei einem REST-Aufruf, der ein POST, ein PATCH, ein UPDATE oder ein DELETE ist), wird das Kästchen zum Bestätigen der Datenänderung angezeigt und muss angeklickt werden, bevor die Anfrage ausgeführt werden kann.

Wenn die Anfrage ausgeführt wird, werden die Ergebnisse auf dem Tab Response (Antwort) angezeigt.

Außerdem wird auf dem Tab Code die SDK-Aufrufsyntax für das SDK angezeigt, das im Drop-down-Menü für die Sprachauswahl ausgewählt wird. Wenn die SDK-Sprachauswahl auf Alle gesetzt ist, wird die SDK-Aufrufsyntax in allen unterstützten SDK-Sprachen, getrennt durch Tabs, angezeigt.

Antwortanzeigetypen

API Explorer-Antworten enthalten einen MIME-Typ, über den 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 Raw (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> und nicht der Beschriftung des Felds angezeigt.

Bei komplexen JSON-Nutzlasten wird die Rasteranzeige weggelassen und nur die JSON-Rohdaten angezeigt.

PNG und JPEG

In den Formaten PNG und JPEG wird die für die Abfrage ausgewählte Visualisierung angezeigt, einschließlich der angewendeten Visualisierungseinstellungen. Das nächste Beispiel ist die PNG-Ausgabe der zuvor gezeigten Abfrage, jedoch mit einer Tabellenvisualisierung. JPEG wird ähnlich gehandhabt.

svg

Einige Looker-Endpunkte geben SVG zurück, das ebenfalls direkt unterstützt wird. Im Folgenden finden Sie ein Beispiel für den Endpunkt content_thumbnail im SVG-Format, der eine abstrakte Miniaturansicht eines Dashboards zurückgibt.

HTML

Bei Anfragen, die HTML-Quellcode zurückgeben, wird der HTML-Quelltext auf dem Tab Antwort angezeigt.

Text

Anfragen, die SQL oder andere MIME-Formate als „Nur Text“ zurückgeben, werden auf dem Tab Antwort im Nur-Text-Format angezeigt.

API-Versionen vergleichen

Der API Explorer enthält eine Seite, auf der Sie verschiedene Versionen der Looker API vergleichen können, um festzustellen, 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 für API Explorer zu öffnen.

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

2. Wählen Sie die API-Optionen aus, die Sie in den Vergleich einbeziehen möchten, um die Methoden nach den Methoden zu filtern, bei denen sich die ausgewählten Optionen unterscheiden. Folgende Optionen sind verfügbar:

   • Fehlt: Zeigt alle Methoden an, die in einer Version der API vorhanden sind und in der anderen fehlen.
   • Status: Zeigt alle Methoden an, bei denen sich der Methodenstatus geändert hat. Dies kann beispielsweise eine Methode sein, bei der sich der Status von beta zu stable geändert hat.
   • Parameter: Zeigt alle Methoden an, bei denen sich mindestens einer der Methodenparameter geändert hat.
   • Typ: Zeigt Typen mit neuen, entfernten oder geänderten Properties an.
   • Text: Zeigt Änderungen an den 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, sowie die Methoden, bei denen es einen Unterschied gibt.

4. Wählen Sie eine Methode aus, um sie zu maximieren. Auf der Vergleichsseite wird ein Unterschied angezeigt, der zeigt, wie sich die Methode zwischen Versionen geändert hat.