Utiliser l'API Explorer

Remarque :Depuis Looker 22.4, l'API Looker 4.0 est disponible à tous. Dans Looker 23.18, l'API Looker 3.1 a été supprimée.

L'explorateur d'API Looker est une extension (une application Web créée à l'aide de composants Looker) développée à l'aide du framework d'extension Looker et déployée via la place de marché Looker.

L'API Explorer fournit les éléments suivants à utiliser avec l'API Looker:

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

L'utilisateur n'a pas besoin de se connecter pour utiliser la version de l'extension d'API Explorer, car elle 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 est autorisé, tout en éliminant la nécessité de fournir des identifiants d'API.

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

Installer API Explorer

L'explorateur d'API est disponible sur la place de marché Looker.

Avant d'installer l'explorateur d'API depuis la place de marché, un administrateur Looker doit activer la fonctionnalité Extension Framework.

Pour installer des applications (telles que l'extension API Explorer) depuis la place de marché, vous devez disposer des autorisations develop, manage_models et deploy. Une fois l'explorateur d'API installé, tout utilisateur disposant au minimum 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 Auto Install (Installation automatique) sur la page Marketplace (Place de marché) de la section Platform (Plate-forme) du menu Admin (Administration) de Looker, l'explorateur d'API sera automatiquement installé sur votre instance. De plus, chaque fois que des mises à jour sont disponibles, elles sont appliquées automatiquement, ce qui garantit que la version de l'explorateur d'API sur votre instance est la plus récente.

Si votre administrateur Looker n'a pas activé l'option Auto Install (Installation automatique), vous devez installer l'explorateur d'API depuis Marketplace Looker.

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

Remarque :Si vous installez API Explorer sur une instance Looker hébergée par le client, le serveur exécutant l'instance Looker doit être configuré pour accéder au serveur Internet public exécuté à l'URL https://githubusercontent.com afin que les utilisateurs puissent afficher des exemples d'API.

Démarrer l'explorateur d'API

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

Remarque :Si vous êtes 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.

Parcourir API Explorer

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

1. Utilisez le sélecteur de langage du SDK pour choisir le langage de programmation dans lequel l'explorateur d'API affichera les déclarations de type et de méthode de l'API, ainsi que les résultats du code. Le sélecteur est défini par défaut sur Python lors du chargement initial. Si vous sélectionnez Toutes dans le sélecteur de langue, l'explorateur d'API affiche une vue par onglet pour chaque langue prise en charge.

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

   • 4.0 - version actuelle

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

4. Saisissez un terme de recherche dans le champ Rechercher pour limiter les méthodes et types affiché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ésumé de la méthode ou du type.

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

6. Sélectionnez l'onglet Types pour afficher les types d'API. Les types ne sont pas catégorisés et sont listé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.

Consulter la documentation sur les méthodes et types d'API

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

1. Toutes les méthodes de cette catégorie s'affichent 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 de méthode spécifique pour filtrer la liste sur ce type de méthode uniquement.

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

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

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

Déclarations de méthode et de type

L'explorateur d'API affiche les déclarations de type et de méthode du SDK dans la langue du SDK sélectionné dans le menu déroulant de sélection de la langue du SDK. Si le sélecteur de langage du SDK est défini sur Tout, les déclarations de méthode et de type s'affichent dans tous les langages de SDK compatibles, séparés par des tabulations.

Exemples de SDK

Le dépôt sdk-codegen de Looker contient un dossier qui contient 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 Exemples de SDK avec des liens vers les exemples.

Si vous sélectionnez une langue de SDK spécifique, les exemples correspondants sont listés en premier.

Des exemples en Ruby et en Java peuvent également s'afficher, bien qu'il ne s'agisse 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 de l'explorateur d'API pour chaque méthode ou type référencé par la méthode ou le type d'origine.

Utiliser "Run It" (Exécuter) pour demander et afficher des appels d'API

API Explorer inclut un bouton Run It (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 Run It (Exécuter), API Explorer affiche un onglet Request (Requête), dans lequel vous pouvez fournir les entrées à la méthode de l'API.

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

Chaque fois que la méthode de l'API peut modifier des données (pour tout appel REST qui est un POST, un PATCH, un UPDATE ou un DELETE), la case de confirmation de la modification des données s'affiche et doit être cochée avant 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.

En outre, 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 langage du SDK est défini sur Tout, la syntaxe d'appel du SDK s'affiche dans tous les langages de SDK compatibles, séparés 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'un tableau. Si Looker détermine que les données de la charge utile sont tabulaires, la grille de données est affichée par défaut pour la réponse.

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

JSON

Les charges utiles JSON peuvent être sous forme de tableau, auquel cas elles s'affichent 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 omettent l'affichage de la grille et n'affichent que le 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 la sortie PNG de la même requête que celle présentée précédemment, mais avec une visualisation de tableau. Le format JPEG est traité de la même manière.

SVG

Certains points de terminaison Looker renvoient du code SVG, qui est également pris en charge directement. Vous trouverez ci-dessous un exemple de point de terminaison content_thumbnail au format SVG, qui renvoie une image miniature abstraite d'un tableau de bord.

HTML

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

Texte

Les requêtes qui renvoient du code SQL ou d'autres formats MIME au format texte brut sont affichées au format texte brut dans l'onglet Réponse.

Comparer les versions d'API

API Explorer 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 uniquement sur celles qui présentent des différences dans les options que vous sélectionnez. Vous disposez des options suivantes :

   • Manquantes : 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 dont l'état est passé de beta à stable.
   • Paramètres : affiche toutes les méthodes pour lesquelles un ou plusieurs paramètres ont changé.
   • Type : affiche les types pour lesquels des propriétés ont été ajoutées, supprimées ou modifiées.
   • Corps : affiche les modifications apportées aux paramètres du corps.
   • Réponse : affiche toutes les méthodes pour lesquelles la réponse de la méthode a changé.

3. La page de comparaison indique le nombre de méthodes pour lesquelles il existe une différence et liste les méthodes concernées.

4. Sélectionnez une méthode pour l'étendre. La page de comparaison affiche alors une comparaison qui montre comment la méthode a évolué entre les versions.