Utiliser l'API Explorer

Remarque :Depuis Looker 22.4, l'API Looker 4.0 est en disponibilité générale. L'API 3.1 est obsolète.

Explorer API Explorer est une extension (une application Web créée à l'aide de composants Looker) développée à l'aide du framework d'extensions Looker et déployée via Looker Marketplace.

APIs Explorer fournit les éléments suivants:

• Documentation sur tous les types et méthodes d'API Looker
• Déclarations de méthode et de type dans tous les langages de SDK compatibles
• Liens vers des exemples de fonctions du SDK utilisant des méthodes d'API
• Liens vers les pages API Explorer pour les méthodes et types référencés
• Une fonction Exécuter qui vous permet d'exécuter directement des appels d'API et qui fournit le code pour les appels d'API, les réponses d'API et les fonctions du SDK.
• Un outil de comparaison qui montre les différences entre les versions de l'API Looker

L'utilisateur n'a pas besoin de se connecter à la version d'API Explorer pour l'extension, car il utilise le compte de l'utilisateur actif pour les requêtes API. Cela garantit que l'utilisateur ne peut effectuer que les appels d'API auxquels il a droit, tout en lui évitant de fournir des identifiants d'API.

La fonctionnalité sudo en tant qu'autre utilisateur de Looker peut également être utilisée pour effectuer des requêtes API en tant qu'utilisateur différent afin de diagnostiquer les problèmes d'accès.

Installer l'explorateur d'API

API Explorer est disponible sur Looker Marketplace.

Avant d'installer APIs Explorer à partir de Marketplace, un administrateur Looker doit activer la fonctionnalité Extension Framework.

Pour installer des applications (comme l'extension API Explorer) à partir de Marketplace, vous devez disposer des autorisations develop, manage_models et deploy. Une fois l'explorateur d'API installé, tout utilisateur disposant au moins de l'autorisation access_data sur le modèle extension_api_explorer peut l'utiliser. Chaque utilisateur peut afficher tous les points de terminaison de l'API dans APIs Explorer, mais ne peut exécuter que ceux autorisés par ses autorisations.

Si votre administrateur Looker a activé l'option Installation automatique sur la page Marketplace dans la section Plate-forme du menu Admin de Looker, l'explorateur d'API sera automatiquement installé sur votre instance. De plus, chaque fois que des mises à jour sont disponibles, elles seront appliquées automatiquement, ce qui permet de s'assurer que la version d'APIs Explorer de votre instance est à jour.

Si votre administrateur Looker n'a pas activé l'option Installer automatiquement, vous devez installer l'explorateur d'API à partir de Looker Marketplace.

Consultez la page de documentation Utiliser Looker Marketplace pour savoir comment installer une extension depuis Looker Marketplace. Pour vous assurer de toujours disposer de la version la plus récente d'API Explorer, accédez à Looker Marketplace, sélectionnez Gérer, puis cliquez sur le bouton Mettre à jour à côté de l'extension.

Remarque :Si vous installez APIs Explorer sur une instance Looker hébergée par le client, les utilisateurs qui exécutent l'instance Looker doivent être configurés pour accéder au serveur Internet public qui s'exécute sous l'URL https://githubusercontent.com.

Démarrer l'explorateur d'API

Une fois l'explorateur d'API installé, vous pouvez y accéder à partir de la section Applications de la barre latérale gauche.

Remarque :Si vous êtes un administrateur Looker, vous pouvez également accéder à l'explorateur d'API en sélectionnant le lien Utiliser l'explorateur d'API sur la page d'administration de l'API de Looker.

Navigation dans l'explorateur d'API

Sur la page d'accueil de l'explorateur d'API, vous pouvez effectuer les tâches suivantes:

1. Utilisez la liste déroulante du sélecteur de langage du SDK pour choisir le langage de programmation dans lequel APIs Explorer affichera les déclarations de la méthode et du type d'API ainsi que les résultats du code. Le sélecteur utilise par défaut Python pour le chargement initial. Si vous sélectionnez Toutes dans le sélecteur de langue, API Explorer affiche une vue à onglets pour chaque langue prise en charge.

2. Utilisez la liste déroulante des versions pour choisir une version de l'API:

   • 4,0 - actuel
   • 3.1 – ancienne version

3. Sélectionnez le bouton Comparer les spécifications pour ouvrir la page de comparaison des versions d'API.

4. Saisissez un terme dans le champ Rechercher pour limiter les méthodes et les types répertoriés à ceux qui incluent du texte correspondant à votre terme de recherche.

   

   Lorsque vous sélectionnez une méthode ou un type renvoyés par la recherche, le terme de recherche est mis en surbrillance dans le récapitulatif de la méthode ou du type.

5. Sélectionnez l'onglet Méthodes pour afficher les catégories de méthodes de l'API. Vous pouvez développer ou réduire une catégorie de méthode pour afficher les méthodes individuelles qu'elle contient.

6. Sélectionnez l'onglet Types pour afficher les types d'API. Les types ne sont pas classés et sont classés par ordre alphabétique.

7. Sélectionnez le bouton Menu principal pour masquer ou afficher le panneau de navigation de l'explorateur d'API.

Afficher la documentation sur la méthode et le type d'API

Lorsque vous sélectionnez une catégorie de méthodes dans l'onglet Method, la catégorie de méthode se développe et affiche toutes les méthodes qui y figurent.

1. Toutes les méthodes de cette catégorie sont affichées dans le panneau principal. Vous pouvez choisir d'afficher toutes les méthodes de la catégorie ou sélectionner l'onglet d'un type en particulier pour filtrer la liste sur ce type de méthode.

2. Pour afficher la documentation d'une méthode spécifique, sélectionnez le nom de la méthode dans le panneau de navigation ou la méthode dans le panneau principal.

Une fois que vous avez sélectionné une méthode spécifique, l'explorateur d'API affiche la documentation de cette méthode.

Lorsque vous sélectionnez un type dans l'onglet Type, la documentation correspondante s'affiche dans le panneau principal.

Déclarations de méthode et de type

API Explorer affiche les déclarations de la méthode et du type du SDK dans le langage du SDK choisi dans le menu déroulant du sélecteur de langue du SDK. Si le sélecteur de langue du SDK est défini sur Toutes, les déclarations de méthode et de type sont affichées dans toutes les langues compatibles, séparées par des tabulations.

Exemples de SDK

Le dépôt sdk-codegen Looker contient un dossier contenant des exemples de SDK Looker. Si le dépôt sdk-codegen contient des exemples pour une méthode, la page API Explorer de la méthode affiche une section SDK Tools (Exemples de SDK) avec des liens vers les exemples.

Si une langue spécifique est sélectionnée, les exemples correspondants s'affichent en premier.

Des exemples Ruby et Java peuvent également s'afficher, même s'il ne s'agit pas de langages de SDK.

Références

La section Références de chaque méthode et type inclut des liens vers les pages APIs Explorer pour chaque méthode ou type référencé par la méthode ou le type d'origine.

Utiliser Run It pour demander et afficher des appels d'API

APIs Explorer comprend un bouton Exécuter qui ouvre un panneau à partir duquel vous pouvez demander des appels d'API et afficher les réponses dans différents formats compatibles.

Lorsque vous sélectionnez le bouton Exécuter, APIs Explorer affiche un onglet Requête dans lequel vous pouvez fournir les entrées à la méthode API.

Saisissez l'entrée souhaitée, puis sélectionnez Exécuter pour exécuter l'appel d'API.

Chaque fois que la méthode API peut modifier les données (pour tout appel REST de type POST, PATCH, UPDATE ou DELETE), la case à cocher de confirmation de modification des données s'affiche et doit être cochée pour que la requête puisse être exécutée.

Lorsque la requête est exécutée, l'onglet Réponse affiche les résultats.

De plus, l'onglet Code affiche la syntaxe d'appel du SDK sélectionné dans le menu déroulant du sélecteur de langue. Si le sélecteur de langue du SDK est défini sur Toutes, la syntaxe d'appel du SDK s'affiche dans toutes les langues compatibles, séparées par des tabulations.

Types d'affichage des réponses

Les réponses de l'explorateur d'API incluent un type MIME qui permet de déterminer comment afficher les résultats.

CSV et autres données tabulaires

Pour les données CSV et JSON, Looker effectue un test de forme pour déterminer si les données répondent aux critères d'une table. Si Looker détermine que les données de charge utile sont tabulaires, l'affichage par défaut de la réponse est une grille de données.

Sélectionnez l'onglet Brut pour afficher les données non transformées.

JSON

Les charges utiles JSON peuvent être tabulaires, auquel cas elles seront affichées dans une grille. Les en-têtes de colonne de la requête LookML s'affichent au format <view_name>.<field_name> au lieu d'afficher le libellé du champ.

Les charges utiles JSON complexes n'affichent pas la grille et n'affichent que le fichier JSON brut.

PNG et JPEG

Les formats PNG et JPEG affichent la visualisation sélectionnée pour la requête et incluent les paramètres de visualisation appliqués. L'exemple suivant est une sortie PNG de la même requête présentée précédemment, mais avec une visualisation sous forme de table. Le traitement JPEG est géré de la même manière.

SVG

Certains points de terminaison Looker renvoient du code SVG, qui est également compatible directement. Vous trouverez ci-dessous un exemple de point de terminaison content_thumbnail au format SVG, qui renvoie la vignette abstraite d'un tableau de bord.

HTML

Les requêtes qui renvoient du code source HTML affichent le code HTML source dans l'onglet Réponse.

Texte

Les requêtes qui renvoient du code SQL ou d'autres formats de type MIME en texte brut s'affichent en texte brut dans l'onglet Réponse.

Comparer les versions de l'API

L'explorateur d'API inclut une page qui vous permet de comparer différentes versions de l'API Looker pour voir ce qui a changé entre les versions. Sélectionnez le bouton triangulaire Comparer les spécifications en haut à droite de la page pour ouvrir la page de comparaison de l'explorateur d'API.

1. Sélectionnez la version de base de l'API et la version de l'API que vous souhaitez comparer à la version de base.

2. Sélectionnez les options d'API que vous souhaitez inclure dans la comparaison pour filtrer les méthodes afin de n'afficher que celles dont les options sont différentes. Vous disposez des options suivantes :

   • Manquant : affiche toutes les méthodes qui existent dans une version de l'API et qui sont manquantes dans l'autre.
   • État : affiche toutes les méthodes dont l'état a changé. Par exemple, une méthode pour laquelle l'état est passé de beta à stable.
   • Paramètres : affiche toutes les méthodes pour lesquelles un ou plusieurs paramètres de méthode ont été modifiés.
   • Type : affiche les types associés à des propriétés nouvelles, supprimées ou modifiées.
   • Corps : affiche les modifications apportées aux paramètres du corps.
   • Réponse : affiche toutes les méthodes dont la réponse a été modifiée.

3. La page de comparaison indique le nombre de méthodes en cas de différence et indique celles qui en comportent.

4. Sélectionnez une méthode pour la développer. La page de comparaison affiche un différent indiquant les changements de méthode entre les versions.