How to generate the API of a websocket request and response?

[alirezaethdev]

I have a Node.js application that functions as a WebSocket server. I can establish a WebSocket connection between my server and Postman, and Postman can receive the response.

Now, I need to document the API of this interaction so that the front-end can utilize it to interact with the WebSocket server.

Upon reviewing the Postman panel, I did not find any option or button to export the API (similar to what we do for HTTP requests). What should I do? How can I export the API of a WebSocket connection?

[danny-dainton]

Hey @alirezaethdev

Welcome to the Postman Community!

Currently, the non HTTP Collections cannot be exported in the same way as the HTTP can be from the app. This is a limitation with those at the moment.

Export collections with WebSocket and gRPC requests

These can be shared between Workspaces, for your team to collaborate on the requests or opened up to a wide group in a Public Workspace.