Partager via

Utiliser Azure CLI pour gérer votre inventaire des API

  • Article

Cet article explique comment utiliser des commandes az apic api dans Azure CLI pour ajouter et configurer des API dans l’inventaire de votre Centre API. Utilisez des commandes dans Azure CLI pour générer des scripts pour gérer votre inventaire d’API et d’autres aspects de votre Centre API.

Prérequis

  • Un Centre d’API dans votre abonnement Azure. Si vous n’en avez pas encore créé, consultez Démarrage rapide : Créer votre centre d’API.

  • Pour Azure CLI :

    Remarque

    Les commandes az apic nécessitent l’extension Azure CLI apic-extension. Si vous n’avez pas utilisé de commandes az apic, l’extension peut être installée dynamiquement lorsque vous exécutez votre première commande az apic, ou vous pouvez l’installer manuellement. Apprenez-en davantage sur les extensions Azure CLI.

    Consultez les notes de publication pour connaître les derniers changements et les dernières mises à jour de l’extension apic-extension.

Inscrire une API, une version d’API et une définition d’API

Les étapes suivantes montrent comment créer une API et comment associer une version d’API unique et une définition d’API. Pour plus d’informations sur le modèle de données dans Azure API Center, consultez Concepts clés.

Création d'une API

Utilisez la commande az apic api create pour créer une API dans votre Centre API.

L’exemple suivant crée une API nommée Petstore API dans le groupe de ressources myResourceGroup et le Centre API myAPICenter. L’API est une API REST.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

Créer une version d’API

Utilisez la commande az apic api version create pour créer une version de votre API.

L’exemple suivant crée une version d’API nommée v1-0-0 pour l’API petstore-api que vous avez créée dans la section précédente. La version est définie sur l’étape de cycle de vie des tests .

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

Créer une définition d’API et ajouter un fichier de spécification

Utilisez les commandes az apic api definition pour ajouter une définition et un fichier de spécification associé pour une version d’API.

Créer une définition

L’exemple suivant utilise la commande az apic api definition create pour créer une définition nommée openapi pour la version d’API de petstore-api que vous avez créée dans la section précédente.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

Importer un fichier de spécification

Importez un fichier de spécification dans la définition en utilisant la commande az apic api definition import-specification.

L’exemple suivant importe un fichier de spécification OpenAPI depuis une URL accessible publiquement vers la définition openapi que vous avez créée à l’étape précédente. Les propriétés name et version de la ressource de spécification sont passées au format JSON.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

Conseil

Vous pouvez importer le fichier de spécification inlined en définissant le paramètre --format sur inline et en passant le contenu du fichier en utilisant le paramètre --value.

Exporter un fichier de spécification

Pour exporter une spécification d’API depuis votre Centre API vers un fichier local, utilisez la commande az apic api definition export-specification.

L’exemple suivant exporte le fichier de spécification depuis la définition openapi que vous avez créée dans la section précédente vers un fichier local nommé specificationFile.json.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

Inscrire l’API depuis un fichier de spécification – étape unique

Vous pouvez inscrire une API depuis un fichier de spécification local en une seule étape en utilisant la commande az apic api register. Avec cette option, une version et une définition d’API par défaut sont créées automatiquement pour l’API.

L’exemple suivant inscrit une API dans le Centre API myAPICenter depuis un fichier de définition OpenAPI local nommé specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • La commande définit les propriétés de l’API comme le nom et le type à partir de valeurs du fichier de définition.
  • Par défaut, la commande définit l’étape du cycle de vie de l’API sur Conception.
  • Cela crée une version d’API nommée en fonction de la propriété version dans la définition de l’API (ou 1-0-0 par défaut) et une définition d’API nommée selon le format de spécification (par exemple openapi).

Mise à jour des propriétés d’API

Après avoir inscrit une API, vous pouvez mettre à jour les propriétés de l’API en utilisant les commandes az apic api update, az apic api version update, et az apic api definition update.

L’exemple suivant met à jour le titre de l’API petstore-api sur Petstore API v2.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

L’exemple suivant définit la propriété personnalisée interne booléenne d’API sur false.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

Supprimer des ressources d’API

Utilisez la commande az apic api delete pour supprimer une API et toutes ses ressources de version et de définition. Par exemple :

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

Pour supprimer des versions et des définitions d’API individuelles, utilisez az apic api version delete et az apic api definition delete, respectivement.

Contenu connexe