Afficher les API API Gateway dans le hub d'API

Cette page explique comment afficher vos API API Gateway dans le hub d'API à l'aide de la console Google Cloud ou de l'API. Pour en savoir plus, consultez Lister les ressources d'API.

Affichez les API API Gateway dans le hub d'API, comme décrit ci-dessous.

ConsoleGoogle Cloud

Pour afficher vos API API Gateway dans le hub d'API, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page API du hub d'API.

    Accéder à l'API Hub

  2. Sélectionnez Passerelle : API Gateway dans le menu déroulant Filtrer pour afficher toutes les API API Gateway.

    La page principale du catalogue d'API s'ouvre et affiche toutes les API disponibles.

  3. Cliquez sur une API pour en afficher les détails.

Le tableau suivant décrit les champs du hub d'API et les met en correspondance avec leurs équivalents dans API Gateway. Consultez également Gérer les attributs dans la documentation du hub d'API pour en savoir plus sur les autres attributs définis par le système et par l'utilisateur.

Champ du hub d'API Champ API Gateway Description
Vue d'ensemble > Nom Détails> Nom Nom de l'API.
Présentation > ID d'API N/A ID de l'API dans le hub d'API.
Aperçu> Dernière modification Détails> Modifié Code temporel de la dernière modification de l'API.
Versions> Nom Configurations> ID de configuration ID de la configuration de l'API.
Versions> ID de version N/A ID de la version de configuration de l'API dans le Hub d'API.
Versions> Dernière modification Configurations> Mise à jour Code temporel de la dernière modification de la configuration de l'API.
Versions> Opérations paths dans le fichier de spécification OpenAPI Opérations définies dans le fichier de spécification. Les détails d'API Gateway ingérés incluent :
  • Chemin d'accès
  • Fichier de spécification
  • Méthode
  • Option obsolète
  • Code temporel de la dernière modification
Versions> Fichier de spécification Configs> Emplacement complet de la ressource Fichier de spécification associé à la configuration de l'API. Les détails d'API Gateway ingérés incluent les éléments suivants :
  • Nom
  • Type de spécification
  • Résultats de l'analyse lint
  • Code temporel de la dernière modification
Remarque : Pour le moment, le hub d'API n'ingère que les fichiers de spécification OpenAPI.
Déploiements> Nom du déploiement Passerelles> ID de passerelle Déploiement API Gateway au format suivant :
LOCATION/GATEWAY_ID
Déploiements> Type de déploiement N/A Type de déploiement. Définissez-le sur API Gateway.
Déploiements> Dernière modification Passerelles> Mise à jour Horodatage de la dernière modification apportée à la passerelle API.
Déploiements> URI des ressources Passerelles> Nom complet de la ressource URI des ressources pour l'API Gateway au format suivant :
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID
Déploiements> URL de gestion Passerelles> passerelle URL utilisée pour gérer le déploiement API Gateway au format suivant :
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID
Déploiements> Projet source Passerelles> Nom complet de la ressource Projet source du déploiement.
Déploiements> Points de terminaison Passerelles> URL de passerelle Adresse IP sur laquelle la ressource de déploiement écoute les requêtes API.
Insights Remarque : Les informations sur les insights ne sont pas disponibles pour les API API Gateway pour le moment.
Sécurité Remarque : Les informations de sécurité ne sont pas disponibles pour les API API Gateway pour le moment.

REST

Pour répertorier toutes les API API Gateway dans le hub d'API, utilisez l'API Lister les API. En ajoutant le filtre d'instance de plug-in, vous pouvez n'afficher que les composants d'API pour l'instance de plug-in API Gateway spécifiée.

Exemple :

curl 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis?filter=source_metadata.plugin_instance_action_source.plugin_instance="projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_TYPE/instances/PLUGIN_INSTANCE_ID"' \
  -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)"

Remplacez les éléments suivants :

  • HUB_PROJECT_ID : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement du hub d'API.
  • HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement du hub d'API.
  • PLUGIN_TYPE : type de plug-in. Définissez-le sur system-api-gateway.
  • PLUGIN_INSTANCE_ID : ID de l'instance du plug-in API Gateway. Utilisez l'API list plugin instances pour obtenir l'ID de l'instance du plug-in.

Voici un exemple de réponse :

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78",
      "displayName": "test-api-1",
      "versions": [
        "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/843a7e72-c5d2-4af8-95b0-162fa5d5ea10",
        "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/b6af2674-4a0e-410e-990d-d90ccbe6867e"
      ],
      "createTime": "2025-12-12T18:55:54.445487Z",
      "updateTime": "2025-12-12T18:55:54.445487Z",
      "apiStyle": {
        "attribute": "projects/myproject/locations/us-west1/attributes/system-api-style",
        "enumValues": {
          "values": [
            {
              "id": "rest",
              "displayName": "REST",
              "description": "REST",
              "immutable": true
            }
          ]
        }
      },
      "fingerprint": "test-api-1",
      "sourceMetadata": [
        {
          "pluginInstanceActionSource": {
            "pluginInstance": "projects/myproject/locations/us-west1/plugins/system-api-gateway/instances/90b21a65-38b4-4159-8e9d-07a8b6cecab0",
            "actionId": "sync-metadata"
          },
          "sourceType": "PLUGIN",
          "originalResourceId": "projects/runtimeproject/locations/global/apis/test-api-1",
          "originalResourceCreateTime": "2025-12-11T01:57:54.841944920Z",
          "originalResourceUpdateTime": "0001-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

Le tableau suivant décrit les champs renseignés avec les métadonnées de l'API provenant d'API Gateway dans la réponse. Consultez également Gérer les attributs dans la documentation du hub d'API pour en savoir plus sur les autres attributs définis par le système et par l'utilisateur.

Champ de l'API Description
name ID de l'API dans le hub d'API au format suivant : projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis/API_ID

Remarque : API_ID est utilisé dans le nom de la ressource pour s'assurer que la valeur est unique.
displayName Nom à afficher de l'API.
createTime Code temporel de la création de l'API.
updateTime Code temporel de la création de l'API.
fingerprint ID unique pour l'API (généralement défini sur le nom à afficher).
sourceMetadata Informations sur l'instance du plug-in API Gateway, y compris :
  • ID de l'instance de plug-in au format suivant : projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/system-api-gateway/instances/PLUGIN_INSTANCE_ID
  • Nom de ressource API Gateway d'origine au format suivant : projects/RUNTIME_PROJECT_ID/locations/LOCATION/apis/API_ID