Socket.IO

Socket.IO is a library that enables low-latency, bidirectional, and event-based communication between clients and servers.

Creating a New Socket.IO Endpoint

Apidog version must be 2.7.0 or higher.

Create a new Socket.IO endpoint

Hover over the+button on the left panel of your project.

Click onNew Socket.IO.

Enter the server address

Input the server address (e.g., ws://localhost:3000).

Supports bothws://and wss:// protocols.

Establish connection

Click theConnectbutton to connect to the server.

Listening to Events

Open theEventstab and enter the event name you want to listen to (e.g., new message). If you disableListenfor a specific event, you will no longer receive messages for that event.

Event Listening Rules:

By default, the system listens to themessageevent.

Adding or removing events dynamically does not affect existing connections.

Changing an event name automatically stops listening to the original event.

Sending Messages

Events & Argument

Set up events and arguments

Event: Defaults tomessage, but you can customize it (e.g., new message).

Argument: Supports JSON, text, and Binary.

Send the message

Click theSendbutton.

View records

Check the timeline for sending records with event tags.

Ack

When you enable theAckoption, the server sends back a callback message after receiving and processing the request.

Multiple Arguments

Click+ Add Argumentto include additional arguments.

When you send a message with multiple arguments, the timeline will display a label like "x Args". Click on it to expand and view all arguments. You can also switch between tabs on the right for more details.

Handshake Request Parameters

You can include request parameters in theURL,Params,Headers, or Cookies.

Client Version and Handshake Path

Configuration Entry

Go toSettingsunderRequest.

Client Version

The default isv4. If the server uses an older version (e.g., v2/v3), manually switch the client version.

Handshake Path

The default is/socket.io. If the server uses a custom path (e.g., /custom), update the path accordingly.

Using Variables

Apidog enables you to include variables in your arguments. When you send a message, these variables are automatically replaced with their real values.

Saving the Endpoint

Once the debugging is complete, click theSavebutton to store the Socket.IO endpoint in the HTTP project’s folder tree. This makes it easy for team members to access, debug, and view the endpoint documentation, improving collaboration and efficiency.

Generating the Endpoint Documentation

Easily manage your Socket.IO endpoint by setting its status, assigningmaintainer, and adding relevanttags. You can also write detailed descriptions usingMarkdown. With Apidog, you can generate online API documentation and share the URL with your team for seamless collaboration.

FAQs

What to do if the connection fails?

Checklist:

Make sure the server is running.

Verify that the client version is compatible with the server.

Ensure the firewall isn't blocking the required port.

Not receiving all arguments?

ACK Not Triggered?

Creating a New Socket.IO Endpoint#

Listening to Events#

Sending Messages#

Events & Argument#

Ack#

Multiple Arguments#

Handshake Request Parameters#

Client Version and Handshake Path#

Using Variables#

Saving the Endpoint#

Generating the Endpoint Documentation#

FAQs#