api - 如何在 swagger 中记录 websocket 事件或回调

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




我有一个设置，可以使用标准 REST 获取一些资源，这在 swagger 中很容易记录。相同的资源在更改时使用 websockets 推送到客户端，因此客户端不必按时间间隔进行拉取。

但是我怎么能用swagger来记录这个呢？甚至有可能吗？如果没有，您建议使用什么其他工具来记录 REST api 和 websocket 部分？

Answer 1

OpenAPI 3 (又名 Swagger 3)在响应格式方面进行了升级，他们添加了回调的概念，允许您定义 webhook。看看这部分文档:response format .

在 Swagger 2 我用来做的是实现一个 API 方法，该方法实现了我对回调的期望，我只是在等待回调的原始方法中引用它。因此，使用 Swagger 规范，任何消费者至少都可以看到我期望从他们那里获得的消息格式。