RAML für Websocket-Definition verwenden

Sie können RAML-Dateien ändern, um Websockets (WS) zu beschreiben. Auf diese Weise können Sie Websocket-Definitionen im API Scan aufzeichnen und in den Tosca Commander exportieren. Sie können dann z. B. das Feature Update API Modules verwenden, um den Wartungsaufwand für Ihre Module gering zu halten.

WS-Beschreibung mit RAML erstellen

Um eine WS-Beschreibung mit RAML zu erstellen, müssen Sie den baseURI und die Methoden der Datei anpassen. Sie können die RAML-Datei jedoch nach Ihren Anforderungen weiter anpassen.

Der baseURI ist ein optionales Feld in RAML, mit dem Sie den Service-Endpunkt einer API und ihrer Ressourcen angeben können. Die Methoden definieren, was mit den Ressourcen zu tun ist, z. B. sie zu senden.

Um eine WS-Beschreibung mit RAML zu erstellen, müssen Sie die folgenden Schritte ausführen:

• Geben Sie einen WS-Endpunkt in das Feld baseURI ein, z. B. ws://localhost/stream.

• Verwenden Sie WS-Methoden in Ihrer RAML-Definition, z. B. send, receive oder connect.

Das folgende Beispiel zeigt, wie Sie eine RAML-Datei ändern können, um einen WS zu beschreiben, und wie der API Scan die Datei nach dem Aufzeichnen anzeigt. Der API Scan identifiziert den baseURI und die Methoden Ihrer RAML-Datei und schaltet automatisch von HTTP auf WS um.

Im API Scan können Sie nun diese Nachrichten ausführen und in den Tosca Commander exportieren.