Postman automatically generates documentation for each of your requests. The documentation includes the request’s URL, parameters, settings, and any saved messages. You can also add a description to help users understand how to use the request.
To view and edit documentation for a WebSocket request, do the following:
- Open the request.
- Click
Documentation in the right sidebar. - Click Add request description.
- Write your content using Postman’s built-in editing tools. Your documentation automatically saves. If you need to make changes, you can edit the description.
In your collection, you can also add a description to the overview or a folder. Click the collection or folder in the sidebar, then click Overview and write your description.