Wanna use swagger for websocket without REST

[artem-korolev]

Hi guys. I try to use swagger for my project. I've got the problem. The thing is that I'm do not need REST at all. All my requests do not use GET, POST or whatever request statuses. My API uses clean websocket. Totally asynchronous nature.

So my question is: how to adopt swagger for my needs. What I need to rewrite/override? or better write some plugin for it?

For example: I don't want to specify my request examples like that:

path: /api_call
get: some get request

Because I dot not use REST(no any GET, POST, ..., etc.). I want to specify it something like that:

endpoint: /api_call
request: describe what client can send
response: describe what client can receive

I noticed in specification that there are schemes available: ws, wss.. But its not documented very well..

So my question is: What are your plans to support NON-REST API, because it becomes very popular. For mobile for example.

Will be glad to speak with some swagger developer or whoever. Because I can implement some module or whatever and share it for public use. But help from swagger development team is appreciated.

Thank you in advance,
Artem

[vibjerg]

+1. I am also interested in the use case outlined by @akoroljov. I have a meta service that communicates with the client via sockets. I would appreciate some pointers on how to accomplish this using swagger

[artem-korolev]

Hi vibjerg, you probably want to read this thread too - OAI/OpenAPI-Specification#523
Several other topics about websocket also already exists here and there. But not much supported yet,

[webron]

Yeah, the referenced issue is the right place. This repo is just for the swagger.io website.