Gérer les versions

Cette page s'applique à Apigee et à Apigee hybrid.

Cette rubrique explique comment créer et gérer des versions d'API. Pour en savoir plus sur les versions, consultez la page Présentation des versions.

Ajouter une version à une API

Vous pouvez ajouter une version d'API à une API existante dans la console ou à l'aide de l'API REST.

Console

Pour ajouter une nouvelle version, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Localisez l'API que vous souhaitez versionner. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour en afficher les détails.
Dans l'onglet Versions, cliquez sur Ajouter une version.
Spécifiez les détails de la version dans le formulaire Ajouter une nouvelle version. Vous devez indiquer un nom à afficher. Les autres attributs sont facultatifs. Pour plus d'informations sur les attributs, consultez Gérer les attributs.
- Name (Nom) : (obligatoire) vous devez indiquer un nom à afficher.
- Description : ajoutez une description de la version.
- Cycle de vie : sélectionnez l'étape du cycle de vie de l'API.
- Conformité : sélectionnez un attribut de conformité.
- Accréditation : sélectionnez un attribut d'accréditation.
- Documentation : saisissez l'URL de la documentation de l'API.
- Ajouter un fichier de spécification: importez un fichier de spécification d'API à associer à la version. Consultez la section Ajouter une spécification d'API à une version.
- Associer à un déploiement: sélectionnez un ou plusieurs déploiements à associer à l'API.
- Attributs définis par l'utilisateur: les attributs définis par l'utilisateur sont des attributs que vous définissez en fonction des besoins de votre organisation ou de votre équipe. Consultez la section Attributs utilisateur.
Cliquez sur Créer.

REST

Pour ajouter une nouvelle version à l'aide de l'API Créer une version d'API, procédez comme suit :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions?version_id=VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME,
    "description": "DESCRIPTION"               # description is an optional attribute
    }'

Remplacez les éléments suivants :

HUB_PROJECT : 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.
API_ID: ID unique de la ressource d'API à laquelle ajouter la version.
VERSION_ID : (facultatif) identifiant unique de la version de l'API. S'il n'est pas fourni, un ID généré par le système sera utilisé. Le nom doit être une chaîne de 4 à 63 caractères, dont les caractères valides sont /[a-z][0-9]-/.
DISPLAY_NAME : (obligatoire) nom à afficher de la version. Vous pouvez utiliser n'importe quel nom.
DESCRIPTION (facultatif) : vous pouvez ajouter un certain nombre d'attributs facultatifs pour décrire la version, y compris une description, un nom de propriétaire, un lien vers la documentation, etc. Ces attributs facultatifs sont répertoriés et décrits dans la définition de la ressource de version.

Exemple de résultat :

{
  "name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
  "displayName": "My Version 1",
  "createTime": "2024-04-02T18:48:41.162360Z",
  "updateTime": "2024-04-02T18:48:41.162360Z"
}

Répertorier les versions d'API

Cette section explique comment lister les versions associées à une API enregistrée.

Console

Pour afficher toutes les versions associées à une API enregistrée dans la console, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Recherchez l'API que vous souhaitez inspecter. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Les versions sont indiquées dans le tableau "Versions" sur la page des détails de l'API.

REST

Pour afficher toutes les versions associées à une API enregistrée à l'aide de l'API Lister les versions d'API :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement d'API Hub.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement d'API Hub.
API_ID: ID unique de la ressource d'API.

Exemple de résultat :

{
  "versions": [
    {
      "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
      "displayName": "Streetcarts Test v1"
    }
  ]
}

Obtenir les détails de la version d'API

Cette section explique comment obtenir des détails sur une version d'API, y compris ses attributs, ses opérations, ses déploiements et ses fichiers de spécification.

Console

Pour afficher les détails d'une version dans la console, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Recherchez l'API que vous souhaitez inspecter. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Dans le tableau "Versions", cliquez sur une version pour afficher la page des détails de la version.

REST

Pour afficher les détails d'une version à l'aide de l'API Obtenir les détails de la version d'API :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement d'API Hub.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement d'API Hub.
API_ID: ID unique de la ressource d'API.
VERSION_ID: ID unique de la version.

Exemple de résultat :

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1",
  "displayName": "Test Version 3",
  "documentation": {},
  "specs": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/specs/docs-spec-1"
  ],
  "apiOperations": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/listpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/createpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/deletepet",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/getpetbyid",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/updatepet"
  ],
  "definitions": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/definitions/pet"
  ],
  "createTime": "2024-04-04T14:53:57.299213423Z",
  "updateTime": "2024-04-04T14:53:58.027321138Z"
}

Supprimer une version d'API

Cette section explique comment supprimer une version d'API associée à une ressource d'API. Vous ne pouvez supprimer une version que si l'ensemble des spécifications, opérations, définitions et déploiements associés sous-jacents sont d'abord supprimés.

Console

Pour supprimer une version, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Recherchez l'API qui contient la version que vous souhaitez supprimer. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Dans le tableau Versions, localisez la version que vous souhaitez supprimer.
Dans le menu Actions (à droite de la ligne contenant la version), cliquez sur Supprimer.

REST

Pour supprimer une version à l'aide de l'API Supprimer une version d'API :

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID'

Remplacez les éléments suivants :

API_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement d'API Hub.
API_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement d'API Hub.
API_ID: ID unique de la ressource d'API.
VERSION_ID : ID de la version à supprimer.

Modifier une version

Console

Pour modifier une version, procédez comme suit :

Dans la console Google Cloud, accédez à la page API Hub.
Accéder au hub d'API
Cliquez sur API.
Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API. Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Dans le tableau Versions, localisez la version que vous souhaitez modifier.
Sélectionnez Modifier dans le menu Actions à droite de la ligne de la version. Vous pouvez également accéder à la fonctionnalité de modification en cliquant sur Modifier la version sur la page d'informations de la version. Pour accéder à la page d'informations, cliquez simplement sur une version dans le tableau des versions.
Une fois les modifications effectuées, cliquez sur Enregistrer pour les enregistrer. Pour obtenir une description des attributs modifiables, consultez la description de la ressource de version dans la documentation de référence de l'API REST.

REST

Pour modifier une version avec l'API REST :

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
    '{
      "display-name": DISPLAY_NAME,  # Use the request body to specify attribute changes
      "description": "DESCRIPTION"

    }'

Remplacez les éléments suivants :

HUB_PROJECT : nom du projet hôte dans API Hub. Le projet hôte a été sélectionné lors du provisionnement d'API Hub.
HUB_LOCATION : emplacement du projet hôte. L'emplacement a été choisi lors du provisionnement d'API Hub.
API_ID: ID unique de l'API contenant la version que vous souhaitez modifier.
VERSION_ID : ID de la version à modifier.
DESCRIPTION: vous pouvez ajouter d'autres attributs modifiables dans le corps de la requête, comme la description et d'autres attributs. Les attributs modifiables sont répertoriés dans la documentation de référence de l'API Apigee Hub. l'API Version de correctif.
LIST_OF_ATTRIBUTES: liste de noms d'attributs complets, séparés par une virgule. Par exemple : ?updateMask="description".

Exemple de résultat :

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
  "displayName": "Streetcarts Test v1",
  "description": "This is a revision of the test version.",
  "documentation": {},
  "createTime": "2024-04-18T19:57:11.870761Z",
  "updateTime": "2024-04-18T20:23:42.465324Z"
}