How to describe WebSocket interface?

Question

For restful services Swagger is a standardized way to describe the interface. Is there already a way to describe Websocket interfaces?

score 13 · Accepted Answer · answered Apr 18 '16 at 06:03

13

Not at the moment. You may want to join the following discussion about supporting Websocket in the next version of OpenAPI/Swagger spec:

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

answered Apr 18 '16 at 06:03

William Cheng

10,137
5
54
79

score 11 · Answer 2 · answered Mar 13 '19 at 19:12

Possibly ASyncAPI? I haven't tried it myself yet, but:

AsyncAPI provides a specification that allows you to define Message-Driven APIs in a machine-readable format. It’s protocol-agnostic, so you can use it for APIs that work over MQTT, AMQP, WebSockets, STOMP, etc. The spec is very similar to OpenAPI/Swagger so, if you’re familiar with them, AsyncAPI should be easy for you.

score -3 · Answer 3 · answered Apr 22 '16 at 14:09

-3

What about swagger-socket project?

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

answered Apr 22 '16 at 14:09

Donghwan Kim

1,111
7
18

4

I had a glance at the project's README and I don't see it answering the question on how to represent Websocket within a Swagger document. Did I miss something? – akauppi Dec 27 '16 at 21:42
3

Looks like Swagger Socket is not about documentation – Sonique Dec 26 '19 at 17:59
1

unfortunately now archived and no longer maintained – mbx Sep 28 '20 at 08:18

How to describe WebSocket interface?

3 Answers3