WebSockets

Create mock WebSocket endpoints for real-time communication.

What is WebSocket Support?

Mockario now supports WebSocket endpoints, allowing you to create mock servers that simulate real-time bidirectional communication. This is perfect for testing chat applications, live notifications, and other real-time features.

Creating WebSocket Endpoints

You can create WebSocket endpoints through the web interface:

1. Navigate to the WebSocket section in the sidebar
2. Click “Add WebSocket Endpoint”
3. Configure the path (e.g., /ws/chat)
4. Set the event type and response
5. Click “Create”

Or via the API:

POST /api/ws-endpoints
{
  "path": "/ws/chat",
  "eventType": "message",
  "response": {
    "message": "Welcome to the chat!",
    "user": "{{faker.person.fullName}}"
  },
  "delay": 0
}

Connecting to WebSocket

In your client application, connect using:

// JavaScript client example
const ws = new WebSocket('ws://localhost:3001/ws/chat');

ws.onopen = () => {
  console.log('Connected to WebSocket');
};

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Received:', data);
};

ws.send(JSON.stringify({ message: 'Hello!' }));

Event Types

WebSocket endpoints can handle different event types:

• message - message - Handles incoming messages
• connection - connection - Triggered on new connections
• disconnect - disconnect - Triggered when client disconnects
• error - error - Triggered on errors

Faker Templates

You can use Faker templates in your responses to generate realistic data. Use the {{faker.module.method}} syntax.

Person

Date & Time

Location

Internet

Commerce & Finance

Data Types

Lorem (Text)

Example: Notification Endpoint

{
  "path": "/ws/notifications",
  "eventType": "message",
  "response": {
    "id": "{{faker.string.uuid}}",
    "type": "notification",
    "title": "{{faker.lorem.sentence}}",
    "message": "{{faker.lorem.paragraph}}",
    "user": {
      "name": "{{faker.person.fullName}}",
      "email": "{{faker.internet.email}}",
      "avatar": "{{faker.image.avatar}}"
    },
    "read": "{{faker.datatype.boolean}}",
    "createdAt": "{{faker.date.recent}}"
  },
  "delay": 1000
}

Authentication

WebSocket endpoints can require authentication. You can enable this in the endpoint settings.

API Reference

WebSocket Endpoints