WebSocket

WebSocket is an API technology that enables full-duplex communication over a single TCP connection. Compared to traditional HTTP requests, WebSocket offers lower latency and higher efficiency, making it ideal for scenarios requiring persistent connections and real-time data transmission, such as online gaming, real-time chat, live notifications, and collaborative applications.

Version Requirement

WebSocket API management is supported in Apidog version 2.2.34 and later.

Creating a WebSocket Endpoint

You can create a WebSocket endpoint within an HTTP project.

Click the "+" button on the left and select "New WebSocket"

Enter the WebSocket server URL, beginning with ws or wss

Click "Connect"

To disconnect the WebSocket endpoint, click "Disconnect"

Best Experience

For the best experience and to utilize the full feature set of the WebSocket API, we recommend using the Apidog client.

Sending Messages

After establishing a WebSocket connection, you can compose messages under the Message tab.

Supported Message Formats

Format Type	Formats
Text Formats	Text, JSON, XML, HTML
Binary Formats	Base64, Hexadecimal

The editor applies syntax highlighting to the message content based on the selected message format. For JSON, XML, or HTML formats, you can also format the input content.

Viewing Messages

The Messages section displays the connection status, sent messages, and received messages in chronological order.

Click a single message to view its details on the right:

Message Type	Default Display	Additional Options
Text Format	Formatted message	Manually switch message format and encoding
Binary Format	Hexdump	View Base64 encoding or original message

Adding Handshake Request Parameters

You can customize the parameters required during the WebSocket handshake, such as Params, Headers, and Cookies, to accommodate authentication or other complex scenarios.

Timing Constraint

Handshake request parameters cannot be modified once the connection is established. They must be configured before establishing the connection or after disconnecting.

Using Variables

You can use Apidog variables in the WebSocket connection's handshake and messages. Learn more about Using variables.

API Documentation

You can set the status, responsible person, and tags for the WebSocket API, and provide a detailed API description in Markdown format.

You can also share the WebSocket API documentation with external teams, who can view it directly in their browser.

Saving the API

After debugging is complete, click the "Save" button to save the WebSocket API to the directory tree of the HTTP project. This allows other team members to debug or view the API documentation.

FAQ

Why is response validation not needed?

For WebSocket requests, the HTTP status code must be 101 when establishing a connection, indicating a successful protocol upgrade. Therefore, validating the status code is typically not necessary.

There is no Auth tab. How can I authenticate the WebSocket API?

Does Apidog support pre-request/test scripts and assertions in WebSocket APIs?

Are request and response examples supported?

Why doesn't the WebSocket API support mocking?

Creating a WebSocket Endpoint#

Sending Messages#

Supported Message Formats#

Viewing Messages#

Adding Handshake Request Parameters#

Using Variables#

API Documentation#

Saving the API#

FAQ#

Creating a WebSocket Endpoint

Sending Messages

Supported Message Formats

Viewing Messages

Adding Handshake Request Parameters

Using Variables

API Documentation

Saving the API

FAQ