Créer une API

Cette page explique comment créer une API.

Prérequis

Avant de pouvoir créer une API, procédez comme suit :

Conditions requises pour les ID d'API

La plupart des commandes gcloud présentées nécessitent de spécifier l'ID de l'API, au format suivant : API_ID. API Gateway applique les exigences suivantes pour l'ID d'API :

  • Ne doit pas comporter plus de 63 caractères.
  • Ne doit contenir que des lettres minuscules, des chiffres ou des tirets.
  • Il ne doit pas commencer par un tiret.
  • Il ne doit pas contenir de trait de soulignement.

Créer une API

créer une API ;

ConsoleGoogle Cloud

Créez et déployez une API, comme décrit dans Déployer une API sur une passerelle.

Google Cloud CLI

Pour créer une API, consultez les sections suivantes :

Étapes pour créer une API

  1. Validez l'ID de projet renvoyé par la commande suivante, afin de vous assurer que le service est créé dans le bon projet.

    gcloud config list project

    Si vous devez changer le projet par défaut, exécutez la commande suivante et remplacez PROJECT_ID par l'ID du projet Google Cloud dans lequel vous souhaitez créer le service :

    gcloud config set project PROJECT_ID

    Si l'ID du projet contient le signe deux-points (:), consultez la section Projets à l'échelle du domaine pour en savoir plus sur la création d'une API dans votre projet.

  2. Affichez l'aide de la commande apis create :

    gcloud api-gateway apis create --help

  3. Exécutez la commande suivante pour créer l'API :

    gcloud api-gateway apis create API_ID

    où :

    Lors de la création de l'API, API Gateway envoie des informations au terminal.

  4. Si l'opération réussit, vous pouvez utiliser la commande suivante pour afficher les détails de la nouvelle API :

    gcloud api-gateway apis describe API_ID

    Cette commande renvoie les éléments suivants :

          createTime: '2020-02-29T21:52:20.297426875Z'
      displayName: API_ID
      managedService: MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog
      name: projects/PROJECT_ID/locations/global/apis/API_ID
      state: ACTIVE
      updateTime: '2020-02-29T21:52:20.647923711Z'

Options de Google Cloud CLI

La Google Cloud CLI accepte de nombreuses options, y compris celles décrites dans la documentation de référence gcloud. De plus, pour API Gateway, vous pouvez définir les options suivantes lorsque vous créez une API :

  • --async : rend le contrôle immédiatement au terminal, sans attendre la fin de l'opération.
  • --display-name=NAME : spécifie le nom à afficher de l'API, c'est-à-dire le nom affiché dans l'interface utilisateur. N'utilisez pas d'espaces dans le nom. Utilisez plutôt des traits d'union et des traits de soulignement. La valeur par défaut est API_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,... : spécifie les libellés associés à la configuration d'API.
  • --managed-service : spécifie un service géré préexistant pour l'API. Consultez également Projets à l'échelle du domaine.

Projets à l'échelle du domaine

Si votre projet est à l'échelle de votre domaine, l'ID de projet comprend le nom du domaine suivi par deux points (:), par exemple, example.com:my-project. Vous devez fournir un service géré valide lorsque vous créez une API dans un projet à portée de domaine.

Si vous utilisez gcloud, indiquez le nom du service géré à l'aide de l'option --managed-service, comme décrit dans les options de la Google Cloud CLI.

Répertorier les API

Répertoriez toutes les API d'un projet.

ConsoleGoogle Cloud

Dans la console Google Cloud , accédez à la page API Gateway.

Accéder à API Gateway

Google Cloud CLI

gcloud api-gateway apis list

Cette commande renvoie un résultat au format suivant :

  NAME                                              DISPLAY_NAME  MANAGED_SERVICE                          STATE
  projects/PROJECT_ID/locations/global/apis/API_ID  API_ID        MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog  ACTIVE

Utilisez l'ID de l'API pour obtenir des informations détaillées sur l'API :

gcloud api-gateway apis describe API_ID

Mettre à jour une API

Une fois l'API créée, vous pouvez mettre à jour ses libellés et son nom à afficher.

ConsoleGoogle Cloud

  1. Dans la console Google Cloud , accédez à la page API Gateway.

    Accéder à API Gateway

  2. Cliquez sur l'API requise.
  3. Cliquez sur l'onglet Détails.
  4. Cliquez sur Modifier Modifier.
  5. Modifiez le nom à afficher ou les libellés, puis cliquez sur Enregistrer.

Google Cloud CLI

Utilisez les options gcloud suivantes pour mettre à jour une API existante :

  • --display-name
  • --update-labels
  • --clear-labels
  • --remove-labels

Exemple :

  gcloud api-gateway apis update API_ID \
    --update-labels=a=1,b=2

Utilisez la commande suivante pour afficher toutes les options de mise à jour :

gcloud api-gateway apis update --help

Supprimer une API

Pour supprimer une API, vous devez :

  • Supprimez les passerelles API associées à l'API et à ses configurations d'API.
  • Supprimer les configurations d'API associées à l'API.
  • Supprimer l'API.

ConsoleGoogle Cloud

  1. Dans la console Google Cloud , accédez à la page API Gateway.

    Accéder à API Gateway

  2. Cliquez sur l'API à supprimer.
  3. Cliquez sur l'onglet Configurations.
  4. Sélectionnez la ou les configurations d'API, puis cliquez sur Plus , puis sur Supprimer.
  5. Cliquez sur pour revenir à la page d'accueil API Gateway.
  6. Cliquez sur Plus , puis sur Supprimer pour supprimer l'API choisie.

Google Cloud CLI

  1. Déterminez la liste des passerelles API associées à l'API :

    gcloud api-gateway gateways list --filter='apiConfig:"projects/PROJECT_ID/locations/global/apis/API_ID"'

  2. Supprimez chaque configuration d'API associée à l'API :

    gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID

  3. Supprimez l'API :

    gcloud api-gateway apis delete API_ID

Étapes suivantes