您如何正式描述您的WebSocket API?

4urapxun  于 2023-03-08  发布在  其他
关注(0)|答案(1)|浏览(188)

REST等同步API通过OpenAPI规范定义良好,可以使用Swagger等平台生成文档和代码,不适合描述Websockets。
这个问题已经在堆栈been asked 6 years ago,我想知道你的WebSocket API和他们的文档的当前状态。
AsyncAPI已经被设计来定义异步API,但它似乎并不很适合WebSocket,它似乎更面向像MQTT这样的发布/订阅协议。
作为参考,交易平台定义了公共WebSocket API:

5ssjco0h

5ssjco0h1#

免责声明,我是AsyncAPI的维护者之一
实际上,对于您提到的两个API,我创建了实验性的AsyncAPI文档:

许多人使用AsyncAPI for WebSocket。简而言之:

  • 如果您的API为多个独立的UI视图在多个路径上启用多个连接,那么一切都在那里
  • 如果你API是WebSocket,但是只有一个连接,然后你使用了一些“子协议”,比如你连接到websocket,然后你发送“订阅”消息来开始接收一些特定的消息--在这种情况下,你需要支持标记请求/回复,这还没有到位,但是你有规范扩展。同样值得注意的是,在几个月内,我们发布了带有原生请求/代表支持的3. 0规范版本。

欢迎加入https://asyncapi.com/slack-invite并在“规范”频道中ping我。我很乐意提供帮助。

相关问题