API Explorer verwenden

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

Der Looker API Explorer ist eine Webanwendung, die mit den Looker-Komponenten erstellt und über den Looker Marketplace bereitgestellt wird.

Der API Explorer stellt folgende Assets bereit:

• Dokumentation zu allen Looker API-Methoden und -Typen
• Deklaration von Methoden und Typen in allen unterstützten SDK-Sprachen
• Links zu Beispiel für SDK-Funktionen, die API-Methoden verwenden
• Links zu API Explorer-Seiten für Referenzmethoden und -typen
• Eine Funktion „Ausführen“, mit der Sie API-Aufrufe direkt ausführen und den Code für die API-Aufrufe, API-Antworten und SDK-Funktionen angeben können
• Ein Vergleichstool, das die Unterschiede in den Looker API-Versionen zeigt

Der Nutzer muss sich nicht für die Erweiterungsversion von API Explorer anmelden, da API Explorer das Konto des aktiven Nutzers für API-Anfragen verwendet. So wird sichergestellt, dass der Nutzer nur die API-Aufrufe ausführen kann, für die er berechtigt ist. Gleichzeitig muss er keine API-Anmeldedaten angeben.

Die sudo-Funktion von Looker kann auch verwendet werden, um API-Anfragen als anderer Nutzer zu senden, um Zugriffsprobleme zu diagnostizieren.

API Explorer installieren

Der API Explorer ist im Looker Marketplace verfügbar.

Vor der Installation des API Explorers aus dem Marketplace muss ein Looker-Administrator das Erweiterungs-Framework aktivieren.

Für die Installation von Anwendungen wie der API Explorer-Erweiterung aus dem Marketplace benötigen Sie die Berechtigungen develop, manage_models und deploy. Sobald der API Explorer installiert ist, kann jeder Nutzer mit 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 von seinen Berechtigungen zugelassen sind.

Wenn Ihr Looker-Administrator auf der Seite Marketplace im Bereich Plattform des Looker-Menüs die Option Automatische Installation aktiviert hat, wird der API Explorer automatisch auf Ihrer Instanz installiert. Außerdem werden alle Updates, die verfügbar sind, automatisch angewendet, damit 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 in der Dokumentation zu Looker Marketplace verwenden. Sie können prüfen, ob Sie immer die aktuelle Version des API Explorers haben, indem Sie den Looker Marketplace aufrufen und Verwalten auswählen. Klicken Sie dann 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 Server unter der URL https://githubusercontent.com konfiguriert sein.

API Explorer starten

Wenn der API Explorer installiert ist, können Sie ihn über den Bereich Anwendungen der linken Seitenleiste aufrufen.

Hinweis :Wenn Sie Looker-Administrator sind, können Sie auch auf den API Explorer zugreifen, indem Sie auf der Looker-Seite API-Administrator auf den Link API Explorer verwenden klicken.

Navigation im API Explorer

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

1. Wählen Sie im Drop-down-Menü für die SDK-Sprachauswahl die Programmiersprache aus, in der der API Explorer API-Methoden- und -Typdeklarationen sowie Codeergebnisse anzeigen soll. Für den Selektor wird beim ersten Laden standardmäßig Python verwendet. Wenn Sie in der Sprachauswahl Alle auswählen, wird der API Explorer eine Tabansicht für jede unterstützte Sprache anzeigen.

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

   • 4,0 – aktuell
   • 3.1 – Legacy

3. Klicken Sie auf die Schaltfläche Vergleichsspezifikationen, um die Seite API-Versionsvergleich zu öffnen.

4. Geben Sie einen Suchbegriff in das Feld Suchen ein, um die aufgeführten Methoden und Typen auf diejenigen einzugrenzen, die Text enthalten, der Ihrem Suchbegriff entspricht.

   

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

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

6. Wählen Sie den Tab Typen aus, um sich API-Typen anzusehen. Typen sind nicht kategorisiert und 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-Methode und Typ ansehen

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

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

2. Wenn Sie die Dokumentation für eine bestimmte Methode aufrufen möchten, können Sie entweder im Navigationsbereich den Methodennamen auswählen oder die Methode im Hauptbereich auswählen.

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

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

Methoden- und Typdeklarationen

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

SDK-Beispiele

Das sdk-codegen-Repository von Looker hat einen Ordner, der Beispiele für das Looker SDK enthält. Wenn das sdk-codegen-Repository Beispiele für eine Methode enthält, wird auf der API Explorer-Seite der Methode der Bereich SDK-Beispiele mit Links zu den Beispielen angezeigt.

Wenn eine bestimmte SDK-Sprache ausgewählt wird, werden zuerst Beispiele für diese Sprache aufgeführt.

Es können auch Ruby- und Java-Beispiele angezeigt werden, die allerdings 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 die einzelnen Methoden und Typen, auf die die ursprüngliche Methode oder der ursprüngliche Typ verweist.

API-Aufrufe mit „Run It“ abrufen und aufrufen

Der API Explorer enthält eine Schaltfläche Ausführen, über die Sie einen Bereich öffnen können, in dem Sie API-Aufrufe anfordern und die Antworten in verschiedenen unterstützten Formaten darstellen können.

Wenn Sie auf die Schaltfläche Ausführen klicken, wird im API Explorer der Tab Anfrage angezeigt, auf dem Sie die Eingaben für die API-Methode vornehmen 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 (für jeden REST-Aufruf, der POST, PATCH, UPDATE oder DELETE ist), wird ein Kästchen zur Bestätigung der Datenänderung angezeigt. Außerdem muss dieses Kästchen angeklickt werden, damit 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ü der 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 von 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 wird in Looker ein Formtest durchgeführt, um festzustellen, ob die Daten die Kriterien einer Tabelle erfüllen. Wenn in Looker festgestellt wird, dass die Nutzlastdaten tabellarisch sind, wird für die Antwort standardmäßig ein Datenraster verwendet.

Wählen Sie den Tab Rohdaten aus, um die nicht transformierten Daten aufzurufen.

JSON

JSON-Nutzlasten können tabellarisch dargestellt werden. 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 und nicht das Label des Felds.

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

PNG und JPEG

Im PNG- und JPEG-Format wird die für die Abfrage ausgewählte Visualisierung angezeigt, einschließlich angewendeter Visualisierungseinstellungen. Das nächste Beispiel ist die PNG-Ausgabe derselben Abfrage, die zuvor gezeigt wurde, aber mit einer Tabellenvisualisierung. JPEG wird ähnlich verarbeitet.

SVG-Bild

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, mit dem ein abstraktes Thumbnail eines Dashboards zurückgegeben wird.

HTML

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

Text

Anfragen, die SQL oder andere Formate zurückgeben, die als MIME-Typ im Nur-Text-Format vorliegen, 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 Vergleichsspezifikationen, um die Vergleichsseite von API Explorer zu öffnen.

1. Wählen Sie die Basisversion der API und die API-Version aus, die mit der Basisversion verglichen werden soll.

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

   • Fehlend: Zeigt alle Methoden an, die in einer Version der API vorhanden sind und in der anderen.
   • Status: Zeigt alle Methoden an, bei denen sich der Methodenstatus geändert hat. Beispiel: Eine Methode, bei der sich der Status von beta zu stable geändert hat.
   • Parameter: Zeigt alle Methoden an, bei denen sich einer oder mehrere der Parameter geändert hat.
   • Typ: Zeigt Typen mit neuen, entfernten oder geänderten Properties an.
   • Text: Zeigt Änderungen an Textparametern an.
   • Antwort: Zeigt alle Methoden an, bei denen es eine Änderung in der Methodenantwort gegeben hat.

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

4. Wählen Sie eine Methode zur Maximierung aus. Die Vergleichsseite zeigt einen Unterschied, der zeigt, wie sich die Methode zwischen den Versionen geändert hat.