Liberty-REST-API-Aktualisierungen subskribieren

Das Liberty-Feature für die REST-API-Erkennung stellt eine neue REST-API (/ibm/api/docs/subscription) bereit, mit der Benutzer REST-API-Aktualisierungen subskribieren können, wie z. B., wenn neue APIs verfügbar sind oder alte APIs entfernt werden. Dies ist hilfreich, wenn ein Benutzer umgehend über Änderungen an den Endpunkten, die von einer bestimmten Liberty-Instanz bereitgestellt werden, benachrichtigt werden will.

Subskriptionen aktivieren

Neben der Basiskonfiguration von apiDiscovery-1.0 muss außerdem websocket-1.0 oder websocket-1.1 in Ihrer Datei server.xml konfiguriert werden.

<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>

Der Endpunkt /ibm/api/docs/subscription ermöglicht POST-Anforderungen mit JSON-Nutzdaten im folgenden Format:

{ "docType" : Zeichenfolge }

Dabei kann für Zeichenfolge der Wert Swagger_20_JSON oder der Wert Swagger_20_YAML angegeben werden. Die zurückgegebenen JSON-Nutzdaten geben den Typ des Subskriptionsfeeds und die zugehörige URL an.

Beispielanforderung und zugehörige Antwort

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

Sie können einen Websocket-Client verwenden, um eine Verbindung zur Feed-URL herzustellen. Sobald eine Verbindung hergestellt wurde, werden weitere Aktualisierungen an REST-APIs im Liberty-Server über das Websocket übertragen. Die Aktualisierung erfolgt je nach Subskription im JSON- oder YAML-Format.


Symbol das den Typ des Artikels anzeigt. Referenzartikel



Symbol für Zeitmarke Letzte Aktualisierung: 01.12.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rwlp_subscribe_restapi
Dateiname: rwlp_subscribe_restapi.html