-
Notifications
You must be signed in to change notification settings - Fork 66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Websocket feature #24
Comments
Thanks for the suggestion! Asyncapi specification supports websockets and it looks like enough information can be gathered automatically from the annotations, so this is absolutely doable. So while springwolf does not support websockets at the moment, definitely expect it in a future version. Also if would like to contribute, we can discuss and design a solution to support it together. |
Is there any news on this? |
Not yet, sorry. If you would like to, I'm open to contributions. |
Is anyone working on this? I'm interested in bringing this to life :) |
That would be great! Work and Covid took most of my available time to contribute to this project. |
Nice :) THX for pushing it forward. |
I'm happy to see this issue move forward. Is there any progress on this issue? |
Not yet. Looks like it could be useful though so I'll try tackling this in the close future hopefully. |
Another issue is how to implement a springwolf publisher for STOMP like the other plugins have. In general, I never worked with websockets, so I will appreciate corrections in terminology and code review. |
I'm a step ahead of you a bit. We can use my drafted Plugin PR for reference. So everything AsyncAPI touches is based on Websockets. HTTP is purely Call-Response (Albeit you can do HTTP-Streams, but that's a separate Topic), where as Websockets allow for Server-Side Events to get pushed to the Client. STOMP is just like AMQP in that they're just protocols for dictating how the data should get transferred over the Websocket Connection. So |
|
Closing due to lack of activity. If someone is interested in contributing this, we will consider re-opening. |
Since we have AsyncAPI support for both STOMP and Websocket, maybe we can take a simple approach providing a simple WDYT? |
Hi!
Thank you for project!
I want to know, can i use it for documenting Spring Websocket functionality?
For example I use next configuration:
And next controller method:
Can I describe it with your project to generate documentation and show it in Swagger like format (like Swagger for REST) and give it to client application? I guess, request, response models and url path will be show inside.
Thank you!
The text was updated successfully, but these errors were encountered: