Noeuds finaux REST pour envoi d'API dans IBM API Connect
Utilisez le noeud final REST, qui est un emplacement central pour les utilisateurs Liberty sur site et dans le cloud, pour visualiser, appeler et envoyer des API dans IBM® API Connect.
Envoi de noeud finaux REST déployés dans IBM API Connect
Pour envoyer des noeuds finaux REST déployés dans IBM API Connect, vous devez appeler un nouveau noeud final REST, /ibm/api/docs/apiconnect, lequel est exposé par la fonction apiDiscovery-1.0 dans la configuration de serveur. Les administrateurs et les développeurs peuvent utiliser les noeuds finaux REST pour exposer des actifs d'une instance Liberty à un développeur de l'entreprise qui effectue une recherche dans les catalogues de l'infrastructure IBM API Connect.
Fourniture d'une définition du produit
Toutes les API sont référencées par un produit et exposées depuis un catalogue. Par conséquent, l'appelant fournit une définition du produit que Liberty utilise pour se référer à ses API RESTful et envoyer le produit résultant dans IBM API Connect. Un exemple de produit est fourni dans cette rubrique.
Exposition d'actifs d'une collectivité Liberty dans IBM API Connect
En utilisant un noeud final de collectivité Liberty correspondant, /ibm/api/collective/docs/apiconnect, vous pouvez exposer tous les actifs d'une collectivité Liberty dans IBM API Connect via un seul déclencheur RESTful . Le noeud final de collectivité Liberty peut exposer des milliers d'API à un développeur de cloud connecté à API Connect. Reportez-vous au LibertyRegistre d'API RESTful, /ibm/api/explorer, pour la définition Swagger complète de ce noeud final.
Récapitulatif de noeud final
Méthode de demande HTTP : POST
URL : https://server:https_port/ibm/api/docs/apiconnect
En-têtes requis
- X-APIM-Authorization
- Données d'identification pour connexion à l'affichage API Connect sous les deux formats suivants :
- nom_utilisateur et mot_de_passe
- xyz où xyz est la version codée en base64 de nom_utilisateur: mot de passe.
Paramètres de requête requis
- Serveur
- Nom du serveur IBM API Connect, débutant par https://.
- Catalogue
- Nom du catalogue hébergeant le produit résultant.
- Organisation
- Nom de l'organisation de l'appelant.
Paramètres de requête facultatifs
- apiRoot
- Paramètre multi-cardinalité spécifiant exactement quels racines de contexte (par exemple, apiRoot=/myApp), l'appelant désire envoyer dans API Connect. Par défaut, Liberty inclut toutes les applications déployées excepté les bundles d'applications Web Liberty d'exécution connus. Ce paramètre est pratique quand vous désirez filtrer les applications à exposer.
- ID membre (disponible uniquement pour la variante Collective)
- Paramètre multi-cardinalité qui spécifie l'ID des membres précis de la collectivité dont l'appelant désire exposer des actifs. Cet ID est composé d'une chaîne contenant le nom d'hôte, le répertoire utilisateur URLEncodeddir et le nom du serveur, séparés par des virgules. Par exemple, myHost.com, %2Ftmp%2Fwlp%2Fusr, server1.
- Corps de l'entrée
- Définition du produit codée YAML ou JSON. Voir l'exemple YAML suivant :
product: "1.0.0" info: name: "pushed-product" title: "A Product that encapsulates Liberty APIs" version: "1.0.0" visibility: view: enabled: true type: "public" tags: - "string" orgs: - "string" subscribe: enabled: true type: "authenticated" tags: - "string" orgs: - "string" apis: liberty: name: "liberty-api:1.0.0" x-ibm-configuration: phase: "realized" testable: true enforced: true cors: enabled: true assembly: execute: - invoke: target-url: "${gateway.target}" title: "Invocation" description: "Invoking back-end service" plans: default: title: "Default Plan" rate-limit: hard-limit: false value: "100/hour" approval: false createdAt: "2016-04-18T20:33:22.937Z" createdBy: "string"