Utiliser l'API Explorer

Cette page explique comment utiliser l'explorateur d'API pour tester les méthodes de l'API Dataproc Metastore. 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 montrant les paramètres de chaque méthode. Remplissez le formulaire, cliquez sur Exécuter, puis consultez les résultats.

Vous pouvez également masquer le widget en cliquant sur le bouton de fermeture en haut du panneau, ou l'afficher en plein écran en cliquant sur ce bouton.

Avant de commencer

  • Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  • Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  • Activez l'API Dataproc Metastore.

    Activer l'API

Accéder à l'explorateur d'API

L'explorateur d'API est associé à la page de référence de 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. Celles qui sont requises sont marquées d'une barre rouge jusqu'à ce qu'elles soient remplies. 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, la zone comporte un en-tête vert contenant 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 API Explorer est associé. La méthode services.create ne contient pas que les paramètres parent et serviceId, mais ce sont les 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 les résultats

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. Ceci est très utile dans le panneau de l'explorateur d'API, où le résultat est affiché dans une zone. Il y a souvent de nombreux résultats à faire défiler.

Astuces

Les sections suivantes contiennent des conseils de l'explorateur d'API.

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 API Explorer. Ces erreurs peuvent entraîner des erreurs ou être acceptées, mais traitées comme des erreurs d'orthographe dans la méthode API:

  • N'utilisez pas de guillemets autour des valeurs de champ, 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 barres obliques inverses ni d'encodage d'URL 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 pouvez alors être confronté au problème.
  • Indiquez une valeur pour le champ pageSize, par exemple 2. Cela limite la quantité de données renvoyées lors du débogage de votre 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 de nouveau exécuter la méthode, collez l'URL dans votre navigateur. Le formulaire contient déjà vos valeurs. Apportez les modifications nécessaires aux paramètres, puis cliquez sur Exécuter pour exécuter à nouveau la méthode.

Authentification

La page Identifiants de la page de l'explorateur d'API se trouve au-dessus du bouton Exécuter. En principe, aucune action de votre part n'est requise.

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. Cette section indique les champs d'application Compute Engine disponibles. Par défaut, tous les champs d'application disponibles sont activés.

Étape suivante