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, o WebSocket oferece menor latência e maior eficiência. É adequado para cenários que exigem ligações persistentes e transmissão de dados em tempo real, como jogos online, chat em tempo real e muito mais.A gestão de APIs WebSocket é suportada nas versões 2.2.34 e posteriores do Apidog.
Criar um endpoint WebSocket#
Pode criar um endpoint WebSocket dentro de um projeto HTTP.1.
Clique no botão + à esquerda e selecione New WebSocket.
2.
Introduza o URL do servidor WebSocket, começando por ws ou wss.
4.
Para desligar o endpoint WebSocket, clique em Disconnect.
Para obter a melhor experiência e utilizar todo o conjunto de funcionalidades da API WebSocket, recomendamos que utilize o cliente Apidog.
Enviar mensagens#
Depois de estabelecer uma ligação WebSocket, pode compor mensagens no separador Message.Além de compor mensagens diretamente em formatos de texto, como Text, JSON, XML e HTML, também pode compor mensagens em formatos binários utilizando Base64 ou Hexadecimal.O editor aplicará realce de sintaxe ao conteúdo da mensagem com base no formato de mensagem selecionado. Se a mensagem estiver no formato JSON, XML ou HTML, também pode formatar o conteúdo introduzido.Ver mensagens#
A secção Messages abaixo apresenta o estado da ligação, as mensagens enviadas e as mensagens recebidas por ordem cronológica.Clique numa única mensagem para ver os respetivos detalhes à direita:Para mensagens em formato de texto, a mensagem formatada será apresentada por predefinição. Pode alternar manualmente o formato e a codificação da mensagem.
Para mensagens em formato binário, o Hexdump da mensagem será apresentado por predefinição. Também pode ver a mensagem codificada com Base64 e a mensagem original.
Adicionar parâmetros do pedido de handshake#
Pode personalizar os parâmetros necessários durante o handshake WebSocket, como Params, Headers e Cookies, para acomodar cenários de autenticação ou outros cenários complexos.Os parâmetros do pedido de handshake não podem ser modificados depois de a ligação ser estabelecida. Têm de ser configurados antes de estabelecer a ligação ou depois de 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 status, a responsible person e as tags para a API WebSocket, bem como fornecer uma descrição detalhada da API no formato Markdown.Também pode partilhar a documentação da API WebSocket com equipas externas, que a podem ver diretamente no respetivo navegador.Guardar a API#
Depois de a depuração estar concluída, 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 vejam a documentação da API.FAQ#
P: Porque é que a validação da resposta não é necessária?R: Para pedidos WebSocket, o código de estado HTTP tem de ser 101 ao estabelecer uma ligação, indicando uma atualização de protocolo bem-sucedida. Portanto, normalmente não é necessário validar o código de estado.P: Não existe separador Auth. Como posso autenticar a API WebSocket?R: Atualmente, são recomendados dois métodos para a autenticação da API WebSocket:1.
Passar as informações de autenticação num campo Param, Header ou Cookie durante o estabelecimento da ligação.
2.
Incluir as informações de autenticação num campo dentro de uma mensagem.
