Abonnement afin de recevoir les mises à jour des API REST Liberty

La fonction de détection des API REST Liberty propose désormais une nouvelle API REST, /ibm/api/docs/subscription, qui permet aux utilisateurs de s'abonner afin de recevoir les mises à jour relatives aux API REST, par exemple, les nouvelles API disponibles ou les anciennes API retirées. Ceci est pratique lorsqu'un utilisateur désire être immédiatement avisé des modifications des noeuds finaux fournis par une instance Liberty spécifique.

Activation des abonnements

Outre la configuration apiDiscovery-1.0 de base, vous devez impérativement configurer également websocket-1.0 ou websocket-1.1 dans votre fichier server.xml.

<server>
    <featureManager>
        <feature>apiDiscovery-1.0</feature>
        <feature>websocket-1.1</feature>
    </featureManager>

    <httpEndpoint id="defaultHttpEndpoint"
                  host="*"
                  httpPort="8010"
                  httpsPort="8020"/>

    <keyStore id="defaultKeyStore" password="Liberty"/>
  
    <basicRegistry id="basic" realm="ibm/api">
        <user name="bob" password="bobpwd" />
    </basicRegistry>
</server>

Le noeud final /ibm/api/docs/subscription permet d'exécuter demandes POST avec un contenu JSON au format suivant :

{ "docType" : String }

String peut être Swagger_20_JSON ou Swagger_20_YAML. Le contenu JSON qui est renvoyé décrit le type de flux d'abonnement et son URL.

Exemple de demande et de réponse correspondante

Demande :
{"docType":"Swagger_20_JSON"}
Réponse :
{
  "feedType": "websocket",
  "feedURL": "wss://myserver.com:8020/ibm/api/docs/subscription/websocket/60db0d79-1863-48f5-a0f9-4fe22a27b82d"
}

Vous pouvez désormais utiliser un client Websocket pour l'établissement d'une connexion à l'URL du flux. Une fois le client connecté, toute mise à jour apportée ultérieurement aux API REST dans le serveur Liberty est insérée via le Websocket. La mise à jour est au format JSON ou YAML selon l'abonnement.


Icône indiquant le type de rubrique Rubrique de référence



Icône d'horodatage Dernière mise à jour: Tuesday, 6 December 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rwlp_subscribe_restapi
Nom du fichier : rwlp_subscribe_restapi.html