L'explorateur d'API Looker est une extension (une application Web conçue à l'aide de composants Looker) qui est développée à l'aide du framework d'extension Looker et déployée via Looker Marketplace.
API Explorer fournit les éléments suivants:
- Documentation pour tous les types et méthodes d'API Looker
- Déclarations de méthode et de type dans tous les langages de SDK compatibles
- Des liens vers des exemples de fonctions SDK qui utilisent des méthodes API
- Liens vers les pages de l'explorateur d'API pour obtenir des 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'extension d'API Explorer, car l'explorateur d'API utilise le compte de l'utilisateur actif pour les requêtes API. Ainsi, l'utilisateur ne peut effectuer que les appels d'API pour lesquels il est autorisé, tout en lui évitant d'avoir à fournir des identifiants d'API.
La fonctionnalité sudo as another user de Looker peut également être utilisée pour envoyer des requêtes API en tant qu'utilisateur différent afin de diagnostiquer les problèmes d'accès.
Installer API Explorer
L'explorateur d'API est disponible sur Looker Marketplace.
Avant d'installer API Explorer à partir de Marketplace, un administrateur Looker doit activer la fonctionnalité Extension Framework.
Pour installer des applications (telles que 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, 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 d'API Explorer sur votre instance est la plus récente.
Si votre administrateur Looker n'a pas activé l'option Installation automatique, vous devrez installer l'explorateur d'API à partir de Looker Marketplace.
Consultez la page de documentation Utiliser Looker Marketplace pour savoir comment installer une extension à partir de Marketplace Looker. Pour être sûr de toujours disposer de la version la plus récente d'API Explorer, accédez à Looker Marketplace, sélectionnez Manage (Gérer), puis cliquez sur le bouton Update (Mettre à jour) à côté de l'extension.
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 gauche.
Naviguer dans l'API Explorer
Sur la page d'accueil de l'API Explorer, vous pouvez effectuer les tâches suivantes:
Dans la liste déroulante de sélection du langage du SDK, choisissez le langage de programmation dans lequel APIs Explorer affichera les déclarations de méthode et de type de l'API, ainsi que les résultats de code. Le sélecteur est défini par défaut sur Python lors du chargement initial. Si vous choisissez Toutes dans le sélecteur de langue, l'explorateur d'API affiche une vue par onglets pour chaque langue disponible.
Utilisez la liste déroulante "Version" pour choisir une version de l'API:
- 4,0 (version actuelle)
Sélectionnez le bouton Compare Specifications (Comparer les spécifications) pour ouvrir la page de comparaison des versions de l'API.
Saisissez un terme de recherche dans le champ Search (Rechercher) pour limiter les méthodes et les types répertoriés à ceux 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 Methods (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 de la catégorie.
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.
Sélectionnez le bouton Menu principal pour afficher ou masquer 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, elle est développée et affiche toutes les méthodes de cette catégorie.
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 de méthode particulier pour filtrer la liste pour n'afficher que ce type de méthode.
Pour consulter 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, 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éthodes et de types
L'explorateur d'API affiche les déclarations de méthode et de type du SDK dans la langue du SDK choisie dans la liste déroulante de sélection de la langue du SDK. Si le sélecteur de langue du SDK est défini sur All (Tout), les déclarations de méthode et de type s'affichent dans toutes les langues compatibles du SDK, en les séparant par des tabulations.
Exemples de SDK
Le dépôt sdk-codegen Looker contient 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 cette méthode affiche une section Exemples de SDK avec des liens vers ces exemples.
Si un langage de SDK spécifique est sélectionné, des exemples pour ce langage sont listés en premier.
Des exemples Ruby et Java peuvent également être affichés, mais 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 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 les appels d'API
L'explorateur d'API inclut un bouton 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 cliquez sur le bouton Run It (Exécuter), l'explorateur d'API affiche un onglet Request (Requête), dans lequel vous pouvez fournir les entrées de 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 de type
POST,PATCH,UPDATEouDELETE), la case de confirmation de la modification des données apparaît 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 indique la syntaxe d'appel du SDK pour le SDK choisi dans la liste déroulante du sélecteur de langue. Si le sélecteur de langue du SDK est défini sur All (Tout), la syntaxe d'appel du SDK s'affiche dans toutes les langues compatibles avec le SDK, en les séparant 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 le mode d'affichage des 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 dans une grille. Les en-têtes de colonne de la requête LookML sont présentés sous la forme <view_name>.<field_name>, au lieu d'afficher le libellé du champ.
Les charges utiles JSON complexes omettent l'affichage sous forme de 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 la 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. Le format JPEG est géré 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 du point de terminaison content_thumbnail au format SVG, qui renvoie une vignette abstraite d'un tableau de bord.
HTML
Les requêtes qui renvoient le code source HTML affichent ce code dans l'onglet Response (Réponse).
Texte
Les requêtes qui renvoient SQL ou d'autres formats MIME en texte brut sont affichées sous forme de texte brut dans l'onglet Response (Réponse).
Comparer les versions de l'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'API 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 afin de n'afficher que celles qui présentent des différences dans les options sélectionnées. 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.
- Status (État) : affiche toutes les méthodes dont l'état a changé. Par exemple, une méthode dans laquelle l'état est passé de
betaàstable. - Paramètres : affiche toutes les méthodes dont un ou plusieurs paramètres de méthode ont été modifiés.
- Type : affiche les types dont les 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 dont la réponse de méthode a été modifiée.
La page de comparaison vous indique le nombre de méthodes qui diffèrent et celles qui présentent une telle différence.
Sélectionnez une méthode pour la développer. La page de comparaison affiche alors une différence qui montre les différences entre les versions de la méthode.