使用RAML Websocket定义

您可以修改RAML文件为了描述Websockets (WS)。这使您能够在扫描Websocket定义API扫描和出口托斯卡指挥官。例如,您可以使用更新API模块特性保持较低的模块的维护工作。

用RAML创建WS描述

创建一个与RAML WS描述,你必须适应文件的baseURI和方法。但是,您可以进一步适应RAML文件根据你的要求。

RAML baseURI是一个可选的字段,你可以使用它来指定一个API及其资源的服务端点。定义如何处理资源的方法,例如,给他们。

创建一个与RAML WS描述,你必须执行以下步骤:

• 输入一个WS的端点baseURI领域,例如ws: / / localhost /流。

• 使用WS RAML定义方法,例如发送,收到,或连接。

下面的例子演示了如何修改RAML文件描述WS和如何API扫描显示在您的文件扫描它。API扫描标识的baseURI和方法你RAML文件并自动切换HTTP / WS。

你现在可以运行这些消息在API扫描和导出到托斯卡指挥官。