Looker API Explorer 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 Looker Marketplace.
APIs Explorer fournit les éléments suivants à utiliser avec l'API Looker:
- Documentation pour toutes les méthodes et tous les types d'API Looker
- Déclarations de méthode et de type dans tous les langages de SDK compatibles
- Liens vers des exemples de fonctions SDK utilisant des méthodes API
- Liens vers les pages de l'explorateur d'API 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 fournit le code des appels d'API, des réponses de l'API et des 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 de l'extension d'API Explorer, car API Explorer utilise le compte de l'utilisateur actif pour les requêtes API. Ainsi, l'utilisateur ne peut effectuer que les appels d'API auxquels il est autorisé, sans avoir à fournir d'identifiants d'API.
La fonctionnalité Looker sudo as another user (sudo en tant qu'autre utilisateur) de Looker permet également d'envoyer des requêtes API en tant qu'utilisateur différent afin de diagnostiquer les problèmes d'accès.
Installer APIs Explorer
L'explorateur d'API est disponible sur Looker Marketplace.
Avant d'installer API Explorer depuis Marketplace, un administrateur Looker doit activer la fonctionnalité Extension Framework.
Pour installer des applications (comme l'extension APIs 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 de la section Plate-forme du menu Administration de Looker, APIs Explorer 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 d'APIs Explorer sur votre instance est la plus récente.
Si votre administrateur Looker n'a pas activé l'option Installation automatique, vous devrez installer APIs Explorer depuis Looker Marketplace.
Consultez la page de documentation Utiliser Marketplace Looker pour savoir comment installer une extension depuis Looker Marketplace. Pour vous assurer de toujours disposer de la version la plus récente d'APIs Explorer, accédez à Looker Marketplace, sélectionnez Gérer, puis cliquez sur le bouton Mettre à jour à côté de l'extension.
Démarrer APIs Explorer
Une fois qu'il est installé, vous pouvez y accéder à partir de la section Applications de la barre latérale de gauche.
Naviguer dans APIs Explorer
À partir de la page d'accueil d'APIs Explorer, vous pouvez effectuer les tâches suivantes:
Utilisez la liste déroulante du sélecteur de langage du SDK pour choisir le langage de programmation dans lequel l'explorateur d'API affichera les déclarations de méthode et de type d'API, ainsi que les résultats de code. Le sélecteur utilise par défaut Python lors du chargement initial. Si vous sélectionnez Toutes dans le sélecteur de langue, APIs Explorer affiche une vue à onglets pour chaque langue compatible.
Utilisez le menu déroulant "Version" pour choisir une version de l'API:
- 4.0 (actuelle)
Cliquez sur le bouton Comparer les spécifications pour ouvrir la page de comparaison des versions de l'API.
Saisissez un terme de recherche dans le champ Rechercher pour limiter les Méthodes et Types répertoriés à celles qui incluent le texte correspondant à votre terme de recherche.
Lorsque vous sélectionnez une méthode ou un type renvoyé par la recherche, le terme de recherche est mis en surbrillance dans le résumé de la méthode ou du type.
Sélectionnez l'onglet Méthodes pour afficher les catégories de méthodes API. Vous pouvez développer ou réduire une catégorie de méthode pour afficher les différentes méthodes qu'elle contient.
Sélectionnez l'onglet Types pour afficher les types d'API. Les types ne sont pas catégorisés et sont classés par ordre alphabétique.
Sélectionnez le bouton Main Menu (Menu principal) pour masquer ou afficher le panneau de navigation de l'explorateur d'API.
Afficher la documentation sur les types et les méthodes d'API
Lorsque vous sélectionnez une catégorie de méthode dans l'onglet Méthode, celle-ci est développée et affiche toutes les méthodes qu'elle contient.
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 correspondant à un type de méthode particulier pour filtrer la liste sur ce type de méthode uniquement.
Pour consulter la documentation d'une méthode spécifique, choisissez le nom de la méthode 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, APIs Explorer affiche la documentation la concernant.
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
L'explorateur d'API affiche les déclarations de méthode et de type du SDK dans la langue du SDK sélectionnée dans la liste déroulante 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 s'affichent dans toutes les langues compatibles du SDK, séparées par des onglets.
Exemples de SDK
Le dépôt sdk-codegen Looker comporte un dossier contenant des exemples du 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 une langue spécifique du SDK est sélectionnée, les exemples pour cette langue sont listés en premier.
Des exemples Ruby et 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 comprend 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 l'option "Exécuter" pour demander et afficher des appels d'API
APIs 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 divers formats compatibles.
Lorsque vous sélectionnez le bouton Run It (Exécuter), l'explorateur d'API affiche un onglet Request (Requête) dans lequel vous pouvez fournir les entrées à la méthode 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 API peut modifier des données (pour tout appel REST qui est
POST,PATCH,UPDATEouDELETE), la case à cocher de confirmation de 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 Response (Réponse) affiche les résultats.
De plus, l'onglet Code affiche la syntaxe des appels SDK pour le SDK sélectionné dans la liste déroulante du sélecteur de langue. Si le sélecteur de langue du SDK est défini sur Toutes, la syntaxe des appels du SDK s'affiche dans toutes les langues compatibles du SDK, séparées par des onglets.
Types d'affichage des réponses
Les réponses de l'explorateur d'API incluent un type MIME utilisé pour 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 RAW pour afficher les données non transformées.
JSON
Les charges utiles JSON peuvent être tabulaires, auquel cas elles seront affichées sous forme de grille. Les en-têtes de colonne de la requête LookML s'affichent sous la forme <view_name>.<field_name>, et non sous l'étiquette du champ.
Les charges utiles JSON complexes omettent l'affichage en 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 tous les paramètres de visualisation appliqués. L'exemple suivant est une sortie PNG de la même requête que celle présentée précédemment, mais en utilisant une visualisation sous forme de tableau. JPEG est traité de la même manière.
SVG
Certains points de terminaison Looker renvoient le format SVG, qui est également directement compatible. Vous trouverez ci-dessous un exemple de point de terminaison content_thumbnail au format SVG, qui renvoie une vignette abstraite d'un tableau de bord.
HTML
Les requêtes qui renvoient un 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 tant que texte brut dans l'onglet Réponse.
Comparer les versions d'une API
L'explorateur d'API comprend 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 Compare Specifications (Comparer les spécifications) en haut à droite de la page pour ouvrir la page de comparaison d'APIs Explorer.
Sélectionnez la version de base de l'API et la version de l'API que vous souhaitez comparer à la version de base.
Sélectionnez les options d'API que vous souhaitez inclure dans la comparaison pour filtrer les méthodes en fonction de celles dont les options sont différentes. Vous disposez des options suivantes :
- Manquante : 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 dont un ou plusieurs paramètres ont été modifiés.
- Type : affiche les types dont les propriétés ont été nouvelles, supprimées ou modifiées.
- Corps : affiche les modifications apportées aux paramètres du corps.
- Réponse : affiche toutes les méthodes ayant subi une modification dans la réponse de la méthode.
La page de comparaison indique le nombre de méthodes présentant des différences et répertorie celles qui présentent une telle différence.
Sélectionnez une méthode pour la développer. La page de comparaison affiche une différence indiquant les modifications apportées à la méthode entre les versions.