Publication d'API et d'applications

Modifier en ligne

Pour publier des API et des applications à l'aide du kit d'outils de développement d' IBM® API Connect, vous pouvez définir des variables de configuration pour définir l'emplacement de publication, vous connecter à la plateforme cloud cible, puis utiliser les commandes de publication appropriées.

Pour plus de détails, reportez-vous aux sections suivantes :

Définition des variables de configuration

La commande apic config fournit des variables de configuration globales et de projet qui spécifient le catalogue cible pour publier les API et les applications. Les valeurs de ces variables sont stockées dans ~/.apiconnect/config (pour les variables globales) et project-dir/.apiconnect (pour les variables de projet). Pour obtenir la liste complète des variables de configuration, consultez la section « Présentation de l'outil en ligne de commande ».

Définissez la variable de configuration catalog sur l'URI d'un catalogue API Connect afin de définir une cible de catalogue par défaut pour toutes les commandes de gestion des catalogues. L'URI catalog prend la forme suivante :

https://mgmt_endpoint_url/api/catalogs/org_name/catalog_name

où url_noeud_final_gestion est l'URL de noeud final d'API de plateforme, nom_org est le nom de l'organisation de type fournisseur et nom_catalogue est le nom du catalogue. La portion url_noeud_final_gestion définit la valeur par défaut de l'option --server, la portion nom_org définit la valeur par défaut de l'option --org, et la portion nom_catalogue définit la valeur par défaut de l'option --catalog. Vous pouvez remplacer ces valeurs en incluant l'option correspondante dans une commande.

Définissez la variable de configuration space sur l'URI d'un espace API Connect , afin de définir une cible Espace par défaut pour toutes les commandes qui gèrent les espaces. L'URI space prend la forme suivante :
https://mgmt_endpoint_url/api/spaces/org_name/catalog_name/space_name
où mgmt_endpoint_url est l' URL point de terminaison de l'API de la plate-forme, org_name est le nom de l'organisation du fournisseur, catalog_name est le nom du catalogue et space_name est le nom de l' espace. La portion url_noeud_final_gestion définit la valeur par défaut de l'option --server, la portion nom_org définit la valeur par défaut de l'option --org, la portion nom_catalogue définit la valeur par défaut de l'option --catalog, et la portion nom_espace définit la valeur par défaut de l'option --space. Vous pouvez remplacer ces valeurs en incluant l'option correspondante dans une commande.

Bien qu'il ne soit pas nécessaire de définir ces variables de configuration, cela simplifie les commandes qui interagissent avec les clouds API Connect en fournissant des valeurs par défaut pour les options de ligne de commande fréquemment utilisées.

Voici un exemple de publication avec et sans la variable de configuration catalog définie.

Sans la variable de configuration définie :

apic products publish climb-on.yaml --server mgmnthost.com --org climbon --catalog sandbox

Avec la variable de configuration définie :

apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
catalog: https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic products publish climb-on.yaml

Vous pouvez remplacer les valeurs par défaut fournies par la variable de configuration catalog en spécifiant l'une des options standard avec une valeur différente. Par exemple, utilisez l'option --catalog avec la commande apic products publish pour spécifier le catalogue qa :

 apic products publish climb-on.yaml --catalog qa

N'oubliez pas les variables de configuration globales. Si vous utilisez le même catalogue que la cible par défaut pour plusieurs projets, définissez la valeur globalement :

 apic config:set --global catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
Remarque :

Si l'une de vos variables d'environnement porte le même nom qu'une propriété de configuration d'interface de ligne de commande, par défaut, sa valeur remplacera celle de la propriété de configuration correspondante dans toutes les commandes d'interface CLI de cette portée.

Par exemple, si vous avez défini une variable d'environnement appelée SPACE, sa valeur sera celle du paramètre --space par défaut, quel que soit le paramètre de la propriété de configuration space :
apic products:publish my_product.yaml --scope space

Pour empêcher les variables d'environnement de remplacer les propriétés de configuration d'interface CLI, définissez une variable d'environnement appelée APIC_LOAD_FROM_ENV et définissez sa valeur sur false.

Se connecter à API Connect

Utilisez les commandes apic login et apic logout pour gérer votre authentification. Pour plus d'informations, consultez le site rapic_cli_login.html.

Publication d'API

La publication d'API dans des catalogues d'API sur API Connect le cloud vous permet de les mettre à la disposition de tous via le catalogue des consommateurs et de les sécuriser à l'aide de la passerelle.

Un produit d'API (ou plus simplement produit) est utilisé afin de composer des API pour leur publication. Les responsables de produits API peuvent s'en servir pour regrouper une ou plusieurs API, contrôler la visibilité du produit dans le catalogue des consommateurs (par exemple, autoriser uniquement les partenaires x, y et z à consulter et à s'abonner au produit) et définir des formules afin de proposer différentes options d'utilisation. Les produits qui référencent les API et définissent les plans de consommation représentent également l'unité principale de la gestion du cycle de vie des API.

Utilisez la commande apic products publish (équivalente à apic products:publish) pour publier des produits d'API dans un cloud API Connect . L'exemple suivant illustre la création d'API composées par un produit, ainsi que la publication du produit et de ses API dans un catalogue :

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"
apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic login --username some-user --password some-password --server platform-api.myserver.com --realm provider/default-idp-2
apic products publish climb-on.yaml

Pour plus d'informations sur la manière de vous connecter à votre serveur de gestion via l'interface de ligne de commande (CLI), consultez la section « Connexion à un serveur de gestion ».

Ajoutez l'option --stage à apic publish pour mettre en préproduction le produit dans un catalogue au lieu de le publier. Les produits d'un catalogue peuvent présenter l'un des états suivants : échelonné, publié, déprécié ou retiré. Par exemple :

apic products publish --stage climb-on.yaml

Vous pouvez utiliser un espace pour partitionner un catalogue afin de permettre à plusieurs équipes peuvent gérer des produits et des API de façon indépendante dans un seul catalogue. Un « espace » s'apparente conceptuellement à un sous-catalogue, à cette différence près que les produits et les API de tous les espaces d'un catalogue sont publiés dans le même catalogue client. Pour plus d'informations sur les espaces, consultez la section « Utilisation de la syndication » sur IBMAPI Connect.

Si des valeurs de configuration par défaut ont été définies pour l' espace, le catalogue, l'organisation et le serveur de gestion, la commande de publication suivante peut être utilisée:
apic products publish --scope space product.yaml
, produit représentant le nom du produit à publier.
Remarque: Si le fichier OpenAPI qui définit votre API utilise une zone $ref pour référencer un fragment de code OpenAPI défini dans un fichier distinct, la zone $ref est remplacée par le contenu du fichier cible avant que le produit contenant l'API ne soit transféré ou publié avec la commande apic publish . Pour plus d'informations, voir Utilisation de $ref pour réutiliser des fragments de code dans vos fichiers OpenAPI.