Socket.IO

Socket.IO é uma biblioteca que permite comunicação de baixa latência, bidirecional e baseada em eventos entre clientes e servidores. Ela fornece canais de comunicação em tempo real e de duas vias por conexões WebSocket, com fallback automático para HTTP long-polling quando WebSocket não estiver disponível.

Pré-requisitos

Apidog versão 2.7.0 ou posterior

Um endpoint de servidor Socket.IO (compatível com os protocolos ws:// e wss://)

Criação de um endpoint Socket.IO

Criar um novo endpoint Socket.IO

Passe o cursor sobre o botão "+" no painel esquerdo do seu projeto

Clique em "New Socket.IO"

Inserir o endereço do servidor

Insira o endereço do servidor (por exemplo, ws://localhost:3000)

Compatível com os protocolos ws:// e wss://

Estabelecer conexão

Clique no botão "Connect" para se conectar ao servidor

Escuta de eventos

Abra a aba Events e insira o nome do evento que você deseja escutar (por exemplo, new message). Desative Listen para um evento específico para parar de receber mensagens desse evento.

Regras de escuta de eventos

Regra	Descrição
Evento padrão	O sistema escuta o evento `message` por padrão
Alterações dinâmicas	Adicionar ou remover eventos não afeta as conexões existentes
Alterações no nome do evento	Alterar o nome de um evento interrompe automaticamente a escuta do evento original

Envio de mensagens

Eventos e argumentos

Configurar eventos e argumentos

Evento: O padrão é message, mas você pode personalizá-lo (por exemplo, new message)

Argumento: Compatível com os formatos JSON, texto e Binário

Enviar a mensagem

Clique no botão "Send"

Visualizar registros

Verifique a linha do tempo para ver os registros de envio com tags de evento

Confirmação (Ack)

Quando você ativa a opção Ack, o servidor envia de volta uma mensagem de callback após receber e processar a requisição.

Múltiplos argumentos

Clique em "+ Add Argument" para incluir argumentos adicionais.

Quando você envia uma mensagem com múltiplos argumentos, a linha do tempo exibe um rótulo como "x Args". Clique nele para expandir e visualizar todos os argumentos. Alterne entre as abas à direita para obter mais detalhes.

enviando-mensagens-com-múltiplos-argumentos.png

Parâmetros da requisição de handshake

Você pode incluir parâmetros da requisição em URL, Params, Headers ou Cookies.

Versão do cliente e caminho de handshake

Entrada de configuração

Vá para Settings em Request

configuração-do-caminho-de-handshake.png

Versão do cliente

O padrão é v4. Se o servidor usar uma versão mais antiga (por exemplo, v2/v3), altere manualmente a versão do cliente

Caminho de handshake

O padrão é /socket.io. Se o servidor usar um caminho personalizado (por exemplo, /custom), atualize o caminho de acordo

Uso de variáveis

O Apidog permite que você inclua variáveis em seus argumentos. Quando você envia uma mensagem, essas variáveis são automaticamente substituídas por seus valores reais.

Salvando o endpoint

Quando a depuração estiver concluída, clique no botão "Save" para armazenar o endpoint Socket.IO na árvore de pastas do projeto HTTP. Isso facilita o acesso, a depuração e a visualização da documentação do endpoint pelos membros da equipe, melhorando a colaboração e a eficiência.

Geração da documentação do endpoint

Gerencie facilmente seu endpoint Socket.IO definindo seu status, atribuindo um mantenedor e adicionando tags relevantes. Você também pode escrever descrições detalhadas usando Markdown. Com o Apidog, você pode gerar documentação de API online e compartilhar a URL com sua equipe para uma colaboração fluida.

Perguntas frequentes

O que fazer se a conexão falhar?

Lista de verificação:

Certifique-se de que o servidor esteja em execução

Verifique se a versão do cliente é compatível com o servidor

Garanta que o firewall não esteja bloqueando a porta necessária

Não está recebendo todos os argumentos?

ACK não foi acionado?

Pré-requisitos#

Criação de um endpoint Socket.IO#

Escuta de eventos#

Regras de escuta de eventos#

Envio de mensagens#

Eventos e argumentos#

Confirmação (Ack)#

Múltiplos argumentos#

Parâmetros da requisição de handshake#

Versão do cliente e caminho de handshake#

Uso de variáveis#

Salvando o endpoint#

Geração da documentação do endpoint#

Perguntas frequentes#