Socket.IO

Socket.IO é uma biblioteca que permite comunicação de baixa latência, bidirecional e baseada em eventos entre clientes e servidores. Fornece canais de comunicação em tempo real e nos dois sentidos através de ligações WebSocket, com recurso automático a HTTP long-polling quando WebSocket não está disponível.

Pré-requisitos

Apidog versão 2.7.0 ou posterior

Um endpoint de servidor Socket.IO (suporta os protocolos ws:// e wss://)

Criar 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"

Introduzir o endereço do servidor

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

Suporta os protocolos ws:// e wss://

Estabelecer ligação

Clique no botão "Connect" para estabelecer ligação ao servidor

Escutar Eventos

Abra o separador Events e introduza o nome do evento que pretende escutar (por exemplo, new message). Desative Listen para um evento específico para deixar de receber mensagens desse evento.

Regras de Escuta de Eventos

Regra	Descrição
Evento Predefinido	O sistema escuta o evento `message` por predefinição
Alterações Dinâmicas	Adicionar ou remover eventos não afeta as ligações existentes
Alterações de Nome de Evento	Alterar o nome de um evento interrompe automaticamente a escuta do evento original

Enviar Mensagens

Eventos e Argumentos

Configurar eventos e argumentos

Evento: A predefinição é message, mas pode personalizá-lo (por exemplo, new message)

Argumento: Suporta os formatos JSON, texto e binário

Enviar a mensagem

Clique no botão "Send"

Ver registos

Consulte a cronologia para ver os registos de envio com etiquetas de evento

Confirmação (Ack)

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

Vários Argumentos

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

Quando envia uma mensagem com vários argumentos, a cronologia apresenta uma etiqueta como "x Args". Clique nela para expandir e ver todos os argumentos. Alterne entre os separadores à direita para obter mais detalhes.

Parâmetros do Pedido de Handshake

Pode incluir parâmetros de pedido no URL, Params, Headers ou Cookies.

Versão do Cliente e Caminho de Handshake

Entrada de Configuração

Aceda a Settings em Request

Versão do Cliente

A predefinição é v4. Se o servidor utilizar uma versão mais antiga (por exemplo, v2/v3), altere manualmente a versão do cliente

Caminho de Handshake

A predefinição é /socket.io. Se o servidor utilizar um caminho personalizado (por exemplo, /custom), atualize o caminho em conformidade

Utilizar Variáveis

O Apidog permite-lhe incluir variáveis nos seus argumentos. Quando envia uma mensagem, estas variáveis são automaticamente substituídas pelos respetivos valores reais.

Guardar 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. Isto facilita o acesso, a depuração e a consulta da documentação do endpoint pelos membros da equipa, melhorando a colaboração e a eficiência.

Gerar Documentação do Endpoint

Faça a gestão do seu endpoint Socket.IO facilmente, definindo o respetivo estado, atribuindo um responsável pela manutenção e adicionando etiquetas relevantes. Também pode escrever descrições detalhadas utilizando Markdown. Com o Apidog, pode gerar documentação de API online e partilhar o URL com a sua equipa para uma colaboração fluida.

Perguntas Frequentes

O que fazer se a ligação falhar?

Lista de verificação:

Certifique-se de que o servidor está em execução

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

Certifique-se de que a firewall não está a bloquear a porta necessária

Não está a receber todos os argumentos?

ACK não acionado?

Pré-requisitos#

Criar um Endpoint Socket.IO#

Escutar Eventos#

Regras de Escuta de Eventos#

Enviar Mensagens#

Eventos e Argumentos#

Confirmação (Ack)#

Vários Argumentos#

Parâmetros do Pedido de Handshake#

Versão do Cliente e Caminho de Handshake#

Utilizar Variáveis#

Guardar o Endpoint#

Gerar Documentação do Endpoint#

Perguntas Frequentes#