如何描述WebSocket接口？

Question

对于宁静的服务，Swagger是一种描述界面的标准化方法。有没有办法描述Websocket接口？

Answer 1

目前不是。您可能希望在下一版本的OpenAPI / Swagger规范中加入以下关于支持Websocket的讨论：

https://github.com/OAI/OpenAPI-Specification/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+Websocket

Answer 2

swagger-socket项目怎么样？

https://github.com/swagger-api/swagger-socket

Answer 3

可能ASyncAPI？我还没有尝试过，但是：

  

AsyncAPI提供了一个规范，使您可以定义   机器可读格式的消息驱动API。它的   与协议无关，因此您可以将其用于通过MQTT工作的API，   AMQP，WebSocket，STOMP等。该规范与   OpenAPI / Swagger，因此，如果您熟悉它们，则AsyncAPI应该是   为您轻松。