Socket.IO

Socket.IO es una biblioteca que permite una comunicación de baja latencia, bidireccional y basada en eventos entre clientes y servidores. Proporciona canales de comunicación en tiempo real y bidireccionales sobre conexiones WebSocket, con conmutación automática a HTTP long-polling cuando WebSocket no está disponible.

Requisitos previos

Apidog versión 2.7.0 o posterior

Un endpoint de servidor Socket.IO (admite los protocolos ws:// y wss://)

Crear un endpoint de Socket.IO

Crear un nuevo endpoint de Socket.IO

Pase el cursor sobre el botón "+" en el panel izquierdo de su proyecto

Haga clic en "New Socket.IO"

Introducir la dirección del servidor

Introduzca la dirección del servidor (por ejemplo, ws://localhost:3000)

Admite los protocolos ws:// y wss://

Establecer la conexión

Haga clic en el botón "Connect" para conectarse al servidor

Escuchar eventos

Abra la pestaña Events e introduzca el nombre del evento que desea escuchar (por ejemplo, new message). Desactive Listen para un evento específico a fin de dejar de recibir mensajes de ese evento.

Reglas de escucha de eventos

Regla	Descripción
Evento predeterminado	El sistema escucha el evento `message` de forma predeterminada
Cambios dinámicos	Agregar o eliminar eventos no afecta a las conexiones existentes
Cambios en el nombre del evento	Cambiar el nombre de un evento detiene automáticamente la escucha del evento original

Enviar mensajes

Eventos y argumentos

Configurar eventos y argumentos

Evento: El valor predeterminado es message, pero puede personalizarlo (por ejemplo, new message)

Argumento: Admite formatos JSON, texto y Binary

Enviar el mensaje

Haga clic en el botón "Send"

Ver registros

Revise la línea de tiempo para ver los registros de envío con etiquetas de evento

Confirmación (Ack)

Cuando habilita la opción Ack, el servidor devuelve un mensaje de callback después de recibir y procesar la petición.

Varios argumentos

Haga clic en "+ Add Argument" para incluir argumentos adicionales.

Cuando envía un mensaje con varios argumentos, la línea de tiempo muestra una etiqueta como "x Args". Haga clic en ella para expandirla y ver todos los argumentos. Cambie entre las pestañas de la derecha para obtener más detalles.

Parámetros de la petición de handshake

Puede incluir parámetros de petición en URL, Params, Headers o Cookies.

Versión del cliente y ruta de handshake

Entrada de configuración

Vaya a Settings en Request

Versión del cliente

El valor predeterminado es v4. Si el servidor utiliza una versión anterior (por ejemplo, v2/v3), cambie manualmente la versión del cliente

Ruta de handshake

El valor predeterminado es /socket.io. Si el servidor utiliza una ruta personalizada (por ejemplo, /custom), actualice la ruta según corresponda

Usar variables

Apidog le permite incluir variables en sus argumentos. Cuando envía un mensaje, estas variables se sustituyen automáticamente por sus valores reales.

Guardar el endpoint

Una vez completada la depuración, haga clic en el botón "Save" para almacenar el endpoint de Socket.IO en el árbol de carpetas del proyecto HTTP. Esto facilita que los miembros del equipo accedan, depuren y consulten la documentación del endpoint, lo que mejora la colaboración y la eficiencia.

Generar documentación del endpoint

Gestione fácilmente su endpoint de Socket.IO estableciendo su estado, asignando un responsable de mantenimiento y agregando etiquetas relevantes. También puede escribir descripciones detalladas con Markdown. Con Apidog, puede generar documentación de API en línea y compartir la URL con su equipo para una colaboración fluida.

Preguntas frecuentes

¿Qué hacer si la conexión falla?

Lista de comprobación:

Asegúrese de que el servidor esté en ejecución

Verifique que la versión del cliente sea compatible con el servidor

Asegúrese de que el firewall no esté bloqueando el puerto requerido

¿No recibe todos los argumentos?

¿ACK no se activa?

Requisitos previos#

Crear un endpoint de Socket.IO#

Escuchar eventos#

Reglas de escucha de eventos#

Enviar mensajes#

Eventos y argumentos#

Confirmación (Ack)#

Varios argumentos#

Parámetros de la petición de handshake#

Versión del cliente y ruta de handshake#

Usar variables#

Guardar el endpoint#

Generar documentación del endpoint#

Preguntas frecuentes#