Gérer les API Cloud et les bibliothèques clientes Cloud dans Cloud Code pour VS Code

Pour accéder aux produits et services Google Cloud par programmation, vous utilisez les API Cloud. Ces API utilisent une interface JSON REST simple. La méthode recommandée pour accéder aux API Cloud consiste à utiliser les bibliothèques clientes Cloud.

Cloud Code facilite l'ajout des bibliothèques clientes Cloud pour les API Cloud et le langage spécifique que vous utilisez dans votre projet. Dans la même vue, vous pouvez rechercher des exemples pour chaque API et intégrer facilement des exemples de code dans votre application.

Parcourir les API Cloud

Pour explorer toutes les API Google Cloud disponibles :

  1. Cliquez sur Cloud Code, puis développez la section API Cloud.

    La vue "API Cloud" regroupe les APIs Cloud par catégorie.

  2. Pour afficher les détails d'une API, cliquez sur son nom. Les détails tels que le nom du service, l'état, les instructions d'installation pour les bibliothèques clientes, la documentation et les exemples de code s'affichent.

Activer les API Cloud

Pour activer les API Cloud pour un projet à l'aide de la page des détails de l'API, procédez comme suit :

  1. Sur la page des détails de l'API Cloud, choisissez le projet pour lequel vous souhaitez activer l'API Cloud.
  2. Cliquez sur Enable API (Activer l'API). Une fois l'API activée, un message s'affiche pour confirmer la modification.

Ajouter des bibliothèques clientes à votre projet

En plus d'explorer et d'activer les API Cloud à l'aide de Cloud Code, vous pouvez également ajouter à votre projet une bibliothèque cliente spécifique au langage.

Pour installer une bibliothèque cliente, suivez les instructions de la page des détails de l'API correspondant à votre langage.

Utiliser des exemples d'API

Vous pouvez rechercher et utiliser des exemples de code pour chaque API dans le navigateur d'API.

  1. Cliquez sur Cloud Code, puis développez la section API Cloud.

  2. Pour ouvrir la vue détaillée, cliquez sur le nom d'une API.

  3. Pour afficher les exemples de code de l'API, cliquez sur Exemples de code.

  4. Pour filtrer la liste des exemples, saisissez du texte à rechercher ou choisissez un langage de programmation dans la liste Langage.

  5. Pour afficher un exemple, cliquez sur son nom. Vous pouvez également copier l'exemple dans le presse-papiers ou l'afficher dans GitHub.

Configurer l'authentification

Une fois que vous avez activé les API et ajouté les bibliothèques clientes nécessaires, vous devez configurer votre application pour qu'elle puisse s'authentifier. La configuration à effectuer dépend du type de développement et de la plate-forme sur laquelle vous exécutez l'application.

Une fois les étapes d'authentification terminées, votre application peut s'authentifier et est prête à être déployée.

Développement local

Machine locale

Si vous vous êtes connecté à Google Cloud dans votre IDE, Cloud Code définit les identifiants par défaut de l'application (ADC), et vous pouvez ignorer cette étape. Si vous vous êtes connecté à Google Cloud en dehors de votre IDE (par exemple, à l'aide de la gcloud CLI), configurez vos identifiants par défaut de l'application et laissez les bibliothèques clientes Google Cloud s'authentifier par le biais des identifiants par défaut de l'application en exécutant la commande suivante :

gcloud auth login --update-adc

Minikube

  1. Si vous vous êtes connecté à Google Cloud dans votre IDE, Cloud Code définit les identifiants par défaut de l'application (ADC), et vous pouvez ignorer cette étape. Si vous vous êtes connecté à Google Cloud en dehors de votre IDE (par exemple, à l'aide de la gcloud CLI), configurez vos identifiants par défaut de l'application et laissez les bibliothèques clientes Google Cloud s'authentifier par le biais des identifiants par défaut de l'application en exécutant la commande suivante :

    gcloud auth login --update-adc
  2. Démarrez Minikube en exécutant minikube start --addons gcp-auth. Cette opération installe dans vos pods les identifiants par défaut de votre application. Pour en savoir plus sur l'authentification de Minikube avec Google Cloud, consultez la documentation gcp-auth de Minikube.

Autres clusters K8s locaux

  1. Si vous vous êtes connecté à Google Cloud dans votre IDE, Cloud Code définit les identifiants par défaut de l'application (ADC), et vous pouvez ignorer cette étape. Si vous vous êtes connecté à Google Cloud en dehors de votre IDE (par exemple, à l'aide de la gcloud CLI), configurez vos identifiants par défaut de l'application et laissez les bibliothèques clientes Google Cloud s'authentifier par le biais des identifiants par défaut de l'application en exécutant la commande suivante :

    gcloud auth login --update-adc
  2. Pour vous assurer que les bibliothèques clientes Google Cloud peuvent trouver vos identifiants, installez votre répertoire local ~/.config/gcloud dans vos pods Kubernetes en modifiant les fichiers manifestes de déploiement.
  3. Définissez l'ID de votre projet Google Cloud en tant que variable d'environnement nommée GOOGLE_CLOUD_PROJECT.

Exemple de configuration de pod Kubernetes :

apiVersion: v1
kind: Pod
metadata:
  name: my-app
  labels:
    name: my-app
spec:
  containers:
  - name: my-app
    image: gcr.io/google-containers/busybox
    ports:
      - containerPort: 8080
    env:
    - name: GOOGLE_CLOUD_PROJECT
      value: my-project-id
    volumeMounts:
      - mountPath: /root/.config/gcloud
        name: gcloud-volume
  volumes:
    - name: gcloud-volume
      hostPath:
        path: /path/to/home/.config/gcloud

Cloud Run

Si vous vous êtes connecté à Google Cloud dans votre IDE, Cloud Code définit les identifiants par défaut de l'application (ADC), et vous pouvez ignorer cette étape. Si vous vous êtes connecté à Google Cloud en dehors de votre IDE (par exemple, à l'aide de la gcloud CLI), configurez vos identifiants par défaut de l'application et laissez les bibliothèques clientes Google Cloud s'authentifier par le biais des identifiants par défaut de l'application en exécutant la commande suivante :

gcloud auth login --update-adc

Développement local avec des API nécessitant un compte de service

Certaines API, comme l'API Cloud Translation, nécessitent un compte de service disposant des autorisations appropriées pour authentifier vos requêtes. Pour en savoir plus, consultez la page Créer et gérer des comptes de service. Pour un guide de démarrage rapide qui utilise un compte de service, consultez Utiliser les bibliothèques clientes Cloud dans Cloud Code.

  1. Pour ouvrir un terminal, cliquez sur Terminal > Nouveau terminal.

  2. Créez un compte de service pour authentifier vos requêtes API :

    gcloud iam service-accounts create \
    SERVICE_ACCOUNT_ID \
    --project PROJECT_ID

    Remplacez les valeurs suivantes :

    • SERVICE_ACCOUNT_ID : ID du compte de service.
    • PROJECT_ID : ID du projet

    Pour trouver ces ID dans Google Cloud, cliquez sur le menu de navigation en haut à gauche de l'écran, pointez sur IAM et administration, puis cliquez sur Comptes de service.

    La colonne Adresse e-mail affiche les SERVICE_ACCOUNT_ID et PROJECT_ID uniques de chacun de vos comptes de service au format suivant :

    SERVICE_ACCOUNT_ID@PROJECT_ID.

    Par exemple, l'adresse e-mail d'un compte de service my-service-account@my-project. possède les valeurs suivantes :

    • SERVICE_ACCOUNT_ID : my-service-account
    • PROJECT_ID : my-project
  3. Attribuez le rôle approprié à votre compte de service. L'exemple de commande suivant attribue le rôle Utilisateur de l'API Cloud Translation. Pour déterminer le rôle à attribuer, consultez la documentation de l'API Cloud que vous utilisez.

    gcloud projects \
    add-iam-policy-binding \