Document WebSocket requests

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:

  1. Open the request.
  2. Select the documentation icon Documentation icon in the right sidebar.
  3. Select Add description.

    You can also select Generate with Postbot to use Postman's AI assistant to document your WebSocket request.

  4. 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.

You can also add a description to your collection’s overview or a folder in your collection. Select the collection or folder in the sidebar, then select Add collection description or Add folder description.

Last modified: 2023/11/01