API Explorer verwenden

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

Der API Explorer bietet folgende Assets:

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

Die Funktion sudo as another user von Looker kann auch verwendet werden, um API-Anfragen als ein anderer Nutzer zu stellen, die bei der Diagnose von Zugriffsproblemen helfen kann.

API Explorer installieren

Der API Explorer ist im Looker Marketplace verfügbar.

Vor der Installation von API Explorer über den Marketplace muss ein Looker-Administrator das Framework für Erweiterungen aktivieren.

Für die Installation von Anwendungen wie der API Explorer-Erweiterung über den Marketplace 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 Modell extension_api_explorer den API Explorer verwenden. Jeder Nutzer kann alle API-Endpunkte im API Explorer ansehen, aber nur die durch seine Berechtigungen zulässigen ausführen.

Wenn Ihr Looker-Administrator die Option Automatische Installation auf der Seite Marketplace im Abschnitt Plattform des Menüs Admin aktiviert hat, wird API Explorer automatisch auf Ihrer Instanz installiert. Wenn Updates verfügbar sind, werden sie automatisch angewendet, damit die Version des API Explorers für Ihre 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.

Eine Anleitung zum Installieren einer Erweiterung aus dem Looker Marketplace finden Sie auf der Dokumentationsseite Looker Marketplace verwenden. Sie können prüfen, ob Sie immer über die neueste Version des API Explorers verfügen. Rufen Sie dazu den Looker Marketplace auf, klicken Sie auf Verwalten und dann neben der Erweiterung auf die Schaltfläche Aktualisieren.

API Explorer starten

Sobald der API Explorer installiert ist, können Sie folgendermaßen darauf zugreifen:

  1. Aus der Liste der installierten Anwendungen und Erweiterungen im Menü Durchsuchen

  2. Auf der Seite Anwendungen &Tools über das Menü Durchsuchen und die linke Seitenleiste

  3. Wenn Sie ein Looker-Administrator sind, können Sie auch auf den API Explorer zugreifen, indem Sie auf den Link API Explorer verwenden auf der API-Administratorseite von Looker klicken.

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 Sprachauswahl des SDK die Programmiersprache aus, in der der API Explorer API-Methoden und Typdeklarationen sowie Codeergebnisse anzeigt. Beim ersten Laden wird standardmäßig Python verwendet. Wenn Sie in der Sprachauswahl Alle auswählen, wird im API Explorer eine Tabansicht für jede unterstützte Sprache angezeigt.

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

    – 4,0 – aktuell

Ab Looker 22.4 ist die Looker API 4.0 allgemein verfügbar. In dieser Version wurde die API 3.1 eingestellt und aus API Explorer entfernt. Dadurch ist API 4.0 die einzige Version, die im API Explorer angezeigt werden kann. Die Vergleichsseite von API Explorer ist zwar noch für zukünftige Releases verfügbar, funktioniert aber derzeit nicht, da nur API 4.0 verfügbar ist.

  1. Geben Sie in das Feld Suchen einen Suchbegriff ein, um die Methoden und Typen auf diejenigen zu beschränken, die Text enthalten, der mit Ihrem Suchbegriff übereinstimmt:

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

  2. Wählen Sie den Tab Methods (Methoden) aus, um API-Methodenkategorien aufzurufen. Sie können eine Methodenkategorie maximieren oder minimieren, um die einzelnen Methoden in der Kategorie zu sehen.

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

  4. Klicken Sie auf das Dreistrich-Symbol, um den Navigationsbereich des API Explorers ein- oder auszublenden.

Dokumentation zu API-Methode und -Typ ansehen

Wenn Sie auf dem Tab Methode eine Kategoriekategorie auswählen, wird die Kategoriekategorie maximiert und Sie sehen alle Methoden in dieser Kategorie:

  1. Im Hauptbereich werden alle Methoden in dieser Kategorie angezeigt. Sie können entweder alle Methoden in der Kategorie anzeigen lassen oder auf den Tab für einen bestimmten Methodentyp klicken, um die Liste nur nach diesem Methodentyp zu filtern.

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

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

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

Methoden- und Typdeklarationen

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

SDK-Beispiele

Das sdk-codegen-Repository von Looker hat einen Ordner, der Beispiele für das Looker SDK enthält. Wenn das Repository sdk-codegen Beispiele für eine Methode enthält, wird auf der Seite "API Explorer" 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. Die folgende SDK-Beispieltabelle zeigt beispielsweise Swift als ausgewählte Sprache:

Möglicherweise sind auch Ruby- und Java-Beispiele zu sehen, auch wenn es sich dabei nicht um SDK-Sprachen handelt.

Verweise

Der Abschnitt Referenzen für die einzelnen Methoden und Typen enthält Links zu den API Explorer-Seiten für die einzelnen Methoden und Typen, auf die die ursprüngliche Methode bzw. der ursprüngliche Typ verweist:

API-Aufrufe über Run It anfordern und anzeigen

Der API Explorer enthält die Schaltfläche Ausführen, über die Sie API-Aufrufe anfordern und die Antworten in einer Vielzahl von unterstützten Formaten anzeigen können:

Wenn Sie auf die Schaltfläche Run (Ausführen) klicken, wird im API Explorer der Tab Request (Anfrage) angezeigt, auf dem Sie die Eingaben für die API-Methode vornehmen können:

Geben Sie die gewünschte Eingabe ein und klicken Sie auf Ausführen, um den API-Aufruf auszuführen.

Immer wenn die API-Methode Daten ändern kann (für jeden REST-Aufruf, der ein POST, ein PATCH, ein UPDATE oder ein DELETE ist), erscheint das Kästchen zur Bestätigung der Datenänderung und muss vor der Ausführung der Anfrage angeklickt werden.

Wenn die Anfrage ausgeführt wird, werden auf dem Tab Response die Ergebnisse angezeigt:

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

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

Für CSV und JSON wird ein einfacher Shape-Test durchgeführt, um festzustellen, ob die Daten wie eine Tabelle aussehen. Wenn die Nutzlastdaten wie eine Tabelle aussehen, ist die Standardanzeige für die Antwort ein Datenraster:

Auf dem Tab Raw (Rohdaten) können die nicht transformierten Daten angezeigt werden:

JSON

JSON-Nutzlasten können tabellarisch sein. In diesem Fall werden sie in einem Raster angezeigt. Die Spaltenüberschriften für die LookML-Abfrage unterscheiden sich im JSON-Format von denen im CSV-Format:

Komplexe JSON-Nutzlasten lassen die Rasteranzeige weg und zeigen nur die JSON-Rohdaten an:

PNG und JPEG

Unten sehen Sie ein Beispiel für dieselbe Abfrage oben im PNG-Format. JPEG wird ähnlich verarbeitet:

SVG-Dateien

Einige Looker-Endpunkte geben SVG zurück, was ebenfalls direkt unterstützt wird. Hier ein Beispiel für den Endpunkt content_thumbnail im SVG-Format:

HTML

Der HTML-Quellcode ist auf dem Tab Antwort hervorgehoben:

Text

SQL und andere Antworten, die als Nur-Text-MIME formatiert sind, werden so angezeigt:

API-Versionen vergleichen

Ab Looker 22.4 ist die Looker API 4.0 allgemein verfügbar. In dieser Version wurde die API 3.1 eingestellt und aus API Explorer entfernt. Dadurch ist API 4.0 die einzige Version, die im API Explorer angezeigt werden kann. Die Vergleichsseite von API Explorer ist zwar noch für zukünftige Releases verfügbar, funktioniert aber derzeit nicht, da nur API 4.0 verfügbar ist.

Der API Explorer enthält eine Seite, auf der Sie verschiedene Versionen der Looker API vergleichen und sehen können, was sich zwischen den Versionen geändert hat. Klicken Sie oben rechts auf das Dreieck, um die Vergleichsseite von 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 einschließen möchten, um die Methoden so zu filtern, dass nur die Optionen angezeigt werden, die sich in den ausgewählten Optionen unterscheiden. Folgende Optionen sind verfügbar:

    • Fehlend: Zeigt alle Methoden an, die in einer API-Version vorhanden sind und in der anderen fehlen.
    • Status: Zeigt alle Methoden an, bei denen sich der Methodenstatus geändert hat. Beispielsweise 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 haben.
    • Typ: Zeigt Typen mit neuen, entfernten oder geänderten Properties an.
    • Text: Zeigt Änderungen an Body-Parametern an.
    • Antwort: Zeigt alle Methoden an, bei denen sich die Antwort in der Methode geändert 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. Klicken Sie auf eine Methode, um sie zu maximieren. Daraufhin wird auf der Vergleichsseite ein Unterschied angezeigt, der Aufschluss darüber gibt, wie sich die Methode zwischen den Versionen geändert hat.