Utiliser l'API Explorer

Cette page explique comment utiliser l'outil API Explorer pour tester les méthodes de l'API Dataproc Metastore. L'API Explorer est un widget associé à la page de référence de l'API REST pour une méthode. Il prend la forme d'un panneau intitulé Try this API (Essayer cette API).

L'outil API Explorerest un excellent moyen de tester des méthodes dans l'API Dataproc Metastore sans avoir à écrire de code. Le widget présente un formulaire affichant les paramètres de chaque méthode. Remplissez le formulaire, cliquez sur le bouton Execute (Exécuter) et affichez les résultats.

Vous pouvez également masquer le widget en cliquant sur le bouton de fermeture en haut du panneau ou le développer en plein écran en cliquant sur le bouton d'affichage en plein écran.

Avant de commencer

Accéder à API Explorer

L'API Explorer est associé à la page de référence pour chaque méthode d'API REST. Pour trouver le widget, accédez à la page de référence d'une méthode, par exemple la page de référence de Dataproc Metastore projects.locations.services.create.

Exécuter une requête minimale

La plupart des méthodes ont des paramètres obligatoires et des paramètres facultatifs. Les paramètres obligatoires sont indiqués par une barre rouge jusqu'à ce qu'ils soient remplis. Vous pouvez exécuter une requête minimale en ne fournissant que les arguments requis.

La méthode services.create crée un service Dataproc Metastore dans un projet et un emplacement choisis. Les champs obligatoires sont les champs parent et serviceId. Pour créer un service, indiquez le numéro et l'ID de l'emplacement de votre projet pour le parent à l'aide du formulaire projects/{projectNumber}/locations/{locationId}. Indiquez l'ID de service pour serviceId.

Essayer

Les résultats de l'appel de méthode s'affichent dans une zone sous le bouton Exécuter. En règle générale, cette zone comporte un en-tête vert avec le code d'état HTTP 200, indiquant que la requête a abouti.

Si l'en-tête est rouge et contient un code d'échec HTTP, la zone contient le message d'erreur. Consultez la section Conseils pour obtenir des conseils sur la résolution des erreurs.

Fournir des paramètres supplémentaires

La liste des paramètres affichés dépend de la méthode à laquelle le widget APIs Explorer est associé. La méthode services.create ne contient pas que les paramètres parent et serviceId, mais il s'agit des seuls paramètres obligatoires.

Vous pouvez utiliser le paramètre facultatif requestId pour spécifier un ID de requête unique permettant au serveur d'ignorer la requête si elle est terminée.

Utiliser des champs pour limiter davantage la sortie

Par défaut, l'ensemble de paramètres affiché par l'API Explorer correspond aux paramètres de la méthode associée. Toutefois, le widget de l'API Explorer comporte également un ensemble de champs supplémentaires qui ne sont pas disponibles via la méthode elle-même.

Ces paramètres sont masqués sous le bouton Afficher les paramètres standards.

Cliquez sur ce bouton pour afficher les paramètres de widget supplémentaires. Cliquez sur Hide standard parameters (Masquer les paramètres standards) pour masquer les paramètres standards.

Le plus utile de ces paramètres standards est le paramètre fields, qui permet de sélectionner les champs de la sortie renvoyée que vous souhaitez afficher. Cela est très utile dans le panneau de APIs Explorer, où la sortie est affichée dans une zone. Il y a souvent de nombreux résultats à faire défiler.

Astuces

Penser à modifier {projectNumber} and {locationId}

N'oubliez pas de remplacer {projectNumber} and {locationId} par le numéro et l'ID d'emplacement de votre projet. Notez que l'API accepte également l'ID de projet à la place du numéro.

Problèmes liés aux valeurs

Voici quelques problèmes à surveiller lors de l'utilisation des formulaires de l'API Explorer. Des valeurs incorrectes peuvent entraîner des erreurs. Elles peuvent aussi être acceptées, mais être traitées comme des fautes d'orthographe dans la méthode API :

  • N'utilisez pas de guillemets autour des valeurs des champs, quel que soit leur type.
  • Veillez à citer les chaînes qui apparaissent dans les filtres. Utilisez des guillemets doubles (") et non des apostrophes (').
  • N'utilisez pas de barre oblique inverse ni d'URL encodées dans les champs de formulaire. Si nécessaire, l'encodage d'URL doit être effectué sur les valeurs de champ lorsque vous exécutez la méthode.
  • Examinez la valeur affichée dans la zone de résultat après l'exécution de l'appel. Vous remarquerez peut-être le problème.
  • Vous pouvez fournir une valeur pour le champ pageSize, telle que 2. Cela limite la quantité de données renvoyée lors du débogage de l'appel d'API.

Ajouter des URL aux favoris pour débogage

Une fois la sortie souhaitée obtenue, ajoutez aux favoris l'URL de l'explorateur d'API. Lorsque vous souhaitez réexécuter la méthode, collez l'URL dans votre navigateur. Le formulaire est déjà renseigné avec vos valeurs. Apportez les modifications nécessaires aux paramètres, puis cliquez sur Exécuter pour réexécuter la méthode.

Authentification

La section Identifiants s'affiche sur la page de l'API Explorer, au-dessus du bouton Exécuter. En règle générale, vous n'avez rien à modifier.

Le mécanisme d'authentification par défaut est Google OAuth 2.0.

La section Identifiants comprend également un bouton Afficher les champs d'application. Elle indique les champs d'application de Compute Engine disponibles. Par défaut, tous les champs d'application disponibles sont activés.

Étape suivante