【问题标题】:How to describe WebSocket interface?如何描述 WebSocket 接口?
【发布时间】:2016-08-09 00:58:37
【问题描述】:

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

【问题讨论】:

    标签: rest interface websocket swagger


    【解决方案1】:

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

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

    【讨论】:

      【解决方案2】:

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

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

      【讨论】:

        【解决方案3】:

        swagger-socket 项目呢?

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

        【讨论】:

        • 我看了一眼项目的自述文件,但我没有看到它回答了如何在 Swagger 文档中表示 Websocket 的问题。我错过了什么吗?
        • 看起来 Swagger Socket 与文档无关
        • 很遗憾现在已存档,不再维护
        猜你喜欢
        • 2013-09-19
        • 2016-12-22
        • 2019-02-09
        • 2016-11-06
        • 1970-01-01
        • 2019-09-27
        • 2016-03-24
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多