WebSocket

WebSocket é uma tecnologia de API que permite comunicação full-duplex por meio de uma única conexão TCP. Em comparação com requisições HTTP tradicionais, WebSocket oferece menor latência e maior eficiência, tornando-o ideal para cenários que exigem conexões persistentes e transmissão de dados em tempo real, como jogos online, chat em tempo real, notificações ao vivo e aplicações colaborativas.

Requisito de versão

O gerenciamento de APIs WebSocket é compatível com o Apidog versão 2.2.34 e posteriores.

Criando um endpoint WebSocket

Você pode criar um endpoint WebSocket dentro de um projeto HTTP.

Clique no botão "+" à esquerda e selecione "Novo WebSocket"

Insira a URL do servidor WebSocket, começando com ws ou wss

Clique em "Conectar"

Para desconectar o endpoint WebSocket, clique em "Desconectar"

Melhor experiência

Para obter a melhor experiência e utilizar todo o conjunto de recursos da API WebSocket, recomendamos usar o cliente Apidog.

Enviando mensagens

Depois de estabelecer uma conexão WebSocket, você pode compor mensagens na aba Mensagem.

Formatos de mensagem compatíveis

Tipo de formato	Formatos
Formatos de texto	Texto, JSON, XML, HTML
Formatos binários	Base64, Hexadecimal

O editor aplica destaque de sintaxe ao conteúdo da mensagem com base no formato de mensagem selecionado. Para os formatos JSON, XML ou HTML, você também pode formatar o conteúdo de entrada.

Visualizando mensagens

A seção Mensagens exibe o status da conexão, as mensagens enviadas e as mensagens recebidas em ordem cronológica.

Clique em uma única mensagem para visualizar seus detalhes à direita:

Tipo de mensagem	Exibição padrão	Opções adicionais
Formato de texto	Mensagem formatada	Alternar manualmente o formato e a codificação da mensagem
Formato binário	Hexdump	Visualizar a codificação Base64 ou a mensagem original

Adicionando parâmetros de requisição de handshake

Você pode personalizar os parâmetros necessários durante o handshake do WebSocket, como Params, Headers e Cookies, para acomodar autenticação ou outros cenários complexos.

Restrição de tempo

Os parâmetros da requisição de handshake não podem ser modificados depois que a conexão é estabelecida. Eles devem ser configurados antes de estabelecer a conexão ou após a desconexão.

Usando variáveis

Você pode usar variáveis do Apidog no handshake e nas mensagens da conexão WebSocket. Saiba mais sobre Como usar variáveis.

Documentação da API

Você pode definir o status, a pessoa responsável e as tags para a API WebSocket, além de fornecer uma descrição detalhada da API em formato Markdown.

Você também pode compartilhar a documentação da API WebSocket com equipes externas, que podem visualizá-la diretamente no navegador.

Salvando a API

Após a conclusão da depuração, clique no botão "Salvar" para salvar a API WebSocket na árvore de diretórios do projeto HTTP. Isso permite que outros membros da equipe depurem ou visualizem a documentação da API.

FAQ

Por que a validação da resposta não é necessária?

Para requisições WebSocket, o código de status HTTP deve ser 101 ao estabelecer uma conexão, indicando uma atualização de protocolo bem-sucedida. Portanto, validar o código de status normalmente não é necessário.

Não há aba Auth. Como posso autenticar a API WebSocket?

O Apidog oferece suporte a scripts de pré-requisição/teste e assertivas em APIs WebSocket?

Há suporte para exemplos de requisição e resposta?

Por que a API WebSocket não oferece suporte a mocking?

Criando um endpoint WebSocket#

Enviando mensagens#

Formatos de mensagem compatíveis#

Visualizando mensagens#

Adicionando parâmetros de requisição de handshake#

Usando variáveis#

Documentação da API#

Salvando a API#

FAQ#

Criando um endpoint WebSocket

Enviando mensagens

Formatos de mensagem compatíveis

Visualizando mensagens

Adicionando parâmetros de requisição de handshake

Usando variáveis

Documentação da API

Salvando a API

FAQ