WebSocket es una tecnología de API que permite la comunicación full-duplex a través de una única conexión TCP. En comparación con las peticiones HTTP tradicionales, WebSocket ofrece menor latencia y mayor eficiencia. Es muy adecuado para escenarios que requieren conexiones persistentes y transmisión de datos en tiempo real, como juegos en línea, chat en tiempo real y más.La gestión de API WebSocket es compatible con Apidog en las versiones 2.2.34 y posteriores.
Crear un endpoint WebSocket#
Puede crear un endpoint WebSocket dentro de un proyecto HTTP.1.
Haga clic en el botón + a la izquierda y seleccione New WebSocket.
2.
Introduzca la URL del servidor WebSocket, comenzando por ws o wss.
4.
Para desconectar el endpoint WebSocket, haga clic en Disconnect.
Para obtener la mejor experiencia y utilizar el conjunto completo de funciones de la API WebSocket, recomendamos usar el cliente de Apidog.
Enviar mensajes#
Después de establecer una conexión WebSocket, puede redactar mensajes en la pestaña Message.Además de redactar mensajes directamente en formatos de texto como Text, JSON, XML y HTML, también puede redactar mensajes en formatos binarios utilizando Base64 o Hexadecimal.El editor aplicará resaltado de sintaxis al contenido del mensaje según el formato de mensaje seleccionado. Si el mensaje está en formato JSON, XML o HTML, también puede dar formato al contenido de entrada.Ver mensajes#
La sección Messages que aparece a continuación muestra el estado de la conexión, los mensajes enviados y los mensajes recibidos en orden cronológico.Haga clic en un mensaje individual para ver sus detalles a la derecha:Para los mensajes en formato de texto, se mostrará el mensaje formateado de forma predeterminada. Puede cambiar manualmente el formato y la codificación del mensaje.
Para los mensajes en formato binario, se mostrará el Hexdump del mensaje de forma predeterminada. También puede ver el mensaje codificado con Base64 y el mensaje original.
Añadir parámetros de petición de handshake#
Puede personalizar los parámetros necesarios durante el handshake de WebSocket, como Params, Headers y Cookies, para adaptarse a la autenticación u otros escenarios complejos.Los parámetros de petición de handshake no se pueden modificar una vez establecida la conexión. Deben configurarse antes de establecer la conexión o después de desconectarla.
Usar variables#
Puede usar variables de Apidog en el handshake y los mensajes de la conexión WebSocket. Obtenga más información sobre Usar variables.Documentación de la API#
Puede establecer el status, el responsible person y las tags para la API WebSocket, y proporcionar una descripción detallada de la API en formato Markdown.También puede compartir la documentación de la API WebSocket con equipos externos, quienes podrán verla directamente en su navegador.Guardar la API#
Una vez completada la depuración, haga clic en el botón Save para guardar la API WebSocket en el árbol de directorios del proyecto HTTP. Esto permite que otros miembros del equipo depuren o vean la documentación de la API.Preguntas frecuentes#
P: ¿Por qué no se necesita la validación de la respuesta?R: Para las peticiones WebSocket, el código de estado HTTP debe ser 101 al establecer una conexión, lo que indica una actualización correcta del protocolo. Por lo tanto, validar el código de estado normalmente no es necesario.P: No hay pestaña Auth. ¿Cómo puedo autenticar la API WebSocket?R: Actualmente, se recomiendan dos métodos para la autenticación de la API WebSocket:1.
Pasar la información de autenticación en un campo Param, Header o Cookie durante el establecimiento de la conexión.
2.
Incluir la información de autenticación en un campo dentro de un mensaje.
