WebSocket

WebSocket é uma tecnologia de API que permite comunicação full-duplex através de uma única ligação TCP. Em comparação com pedidos HTTP tradicionais, WebSocket oferece menor latência e maior eficiência, tornando-se ideal para cenários que requerem ligações persistentes e transmissão de dados em tempo real, tais como jogos online, chat em tempo real, notificações em direto e aplicações colaborativas.

Requisito de versão

A gestão de APIs WebSocket é suportada no Apidog versão 2.2.34 e posteriores.

Criar um endpoint WebSocket

Pode criar um endpoint WebSocket dentro de um projeto HTTP.

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

Introduza o URL do servidor WebSocket, começando com ws ou wss

Clique em "Connect"

Para desligar o endpoint WebSocket, clique em "Disconnect"

Melhor experiência

Para obter a melhor experiência e utilizar o conjunto completo de funcionalidades da API WebSocket, recomendamos a utilização do cliente Apidog.

Enviar mensagens

Depois de estabelecer uma ligação WebSocket, pode compor mensagens no separador Message.

Formatos de mensagem suportados

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

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

Visualizar mensagens

A secção Messages apresenta o estado da ligação, as mensagens enviadas e as mensagens recebidas por ordem cronológica.

Clique numa mensagem individual para ver os respetivos detalhes à direita:

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

Adicionar parâmetros do pedido de handshake

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

Restrição de temporização

Os parâmetros do pedido de handshake não podem ser modificados depois de a ligação ser estabelecida. Devem ser configurados antes de estabelecer a ligação ou depois de a desligar.

Utilizar variáveis

Pode utilizar variáveis do Apidog no handshake e nas mensagens da ligação WebSocket. Saiba mais sobre Utilizar variáveis.

Documentação da API

Pode definir o estado, a pessoa responsável e as etiquetas para a API WebSocket, bem como fornecer uma descrição detalhada da API em formato Markdown.

Também pode partilhar a documentação da API WebSocket com equipas externas, que podem visualizá-la diretamente no respetivo navegador.

Guardar a API

Depois de concluir a depuração, clique no botão "Save" para guardar a API WebSocket na árvore de diretórios do projeto HTTP. Isto permite que outros membros da equipa depurem ou visualizem a documentação da API.

Perguntas frequentes

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

Para pedidos WebSocket, o código de estado HTTP deve ser 101 ao estabelecer uma ligação, indicando uma atualização de protocolo bem-sucedida. Por conseguinte, a validação do código de estado normalmente não é necessária.

Não existe separador Auth. Como posso autenticar a API WebSocket?

O Apidog suporta scripts de pré-pedido/teste e asserções em APIs WebSocket?

São suportados exemplos de pedido e resposta?

Porque é que a API WebSocket não suporta mocking?

Criar um endpoint WebSocket#

Enviar mensagens#

Formatos de mensagem suportados#

Visualizar mensagens#

Adicionar parâmetros do pedido de handshake#

Utilizar variáveis#

Documentação da API#

Guardar a API#

Perguntas frequentes#

Criar um endpoint WebSocket

Enviar mensagens

Formatos de mensagem suportados

Visualizar mensagens

Adicionar parâmetros do pedido de handshake

Utilizar variáveis

Documentação da API

Guardar a API

Perguntas frequentes