如何描述WebSocket接口



对于restful服务,Swagger是描述接口的标准化方法。是否已经有一种方法来描述Websocket接口?

目前没有。您可能想加入以下关于在下一版本的OpenAPI/Swagger规范中支持Websocket的讨论:

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

可能是ASyncAPI?我自己还没有试过,但是:

AsyncAPI提供了一个规范,允许您定义机器可读格式的消息驱动API。它是协议无关,因此您可以将其用于通过MQTT工作的API,AMQP、WebSockets、STOMP等。规范与OpenAPI/Swagger,因此,如果您熟悉它们,AsyncAPI应该对你来说很容易。

swagger套接字项目怎么样?

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

最新更新