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. É adequado para cenários que exigem conexões persistentes e transmissão de dados em tempo real, como jogos online, chat em tempo real e muito mais.O gerenciamento de APIs WebSocket é compatível com as versões 2.2.34 e posteriores do Apidog.
Criando um endpoint WebSocket#
Você pode criar um endpoint WebSocket dentro de um projeto HTTP.1.
Clique no botão + à esquerda e selecione New WebSocket.
2.
Insira a URL do servidor WebSocket, começando com ws ou wss.
4.
Para desconectar o endpoint WebSocket, clique em Disconnect.
Para obter a melhor experiência e utilizar o conjunto completo de recursos da API WebSocket, recomendamos usar o cliente Apidog.
Enviando mensagens#
Após estabelecer uma conexão WebSocket, você pode compor mensagens na aba Message.Além de compor mensagens diretamente em formatos de texto, como Text, JSON, XML e HTML, você também pode compor mensagens em formatos binários usando Base64 ou Hexadecimal.O editor aplicará destaque de sintaxe ao conteúdo da mensagem com base no formato de mensagem selecionado. Se a mensagem estiver no formato JSON, XML ou HTML, você também poderá formatar o conteúdo de entrada.Visualizando mensagens#
A seção Messages abaixo exibe o status da conexão, as mensagens enviadas e as mensagens recebidas em ordem cronológica.Clique em uma única mensagem para ver seus detalhes à direita:Para mensagens em formato de texto, a mensagem formatada será exibida por padrão. Você pode alternar manualmente o formato e a codificação da mensagem.
Para mensagens em formato binário, o Hexdump da mensagem será exibido por padrão. Você também pode visualizar a mensagem codificada com Base64 e 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 atender a cenários de autenticação ou outros cenários complexos.Os parâmetros de 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 responsible person e as tags para a API WebSocket e fornecer uma descrição detalhada da API no formato Markdown.Você também pode compartilhar a documentação da API WebSocket com equipes externas, que poderão visualizá-la diretamente no navegador.Salvando a API#
Após concluir a depuração, clique no botão Save 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.Perguntas frequentes#
P: Por que a validação da resposta não é necessária?R: 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.P: Não há aba Auth. Como posso autenticar a API WebSocket?R: Atualmente, dois métodos são recomendados para autenticação de API WebSocket:1.
Passe as informações de autenticação em um campo Param, Header ou Cookie durante o estabelecimento da conexão.
2.
Inclua as informações de autenticação em um campo dentro de uma mensagem.
