WebSocket은 단일 TCP 연결을 통해 전이중 통신을 가능하게 하는 API 기술입니다. 기존 HTTP 요청과 비교할 때 WebSocket은 더 낮은 지연 시간과 더 높은 효율성을 제공합니다. 온라인 게임, 실시간 채팅 등 지속 연결 및 실시간 데이터 전송이 필요한 시나리오에 적합합니다.WebSocket API 관리는 Apidog 버전 2.2.34 이상에서 지원됩니다.
WebSocket 엔드포인트 생성#
HTTP 프로젝트 내에서 WebSocket 엔드포인트를 생성할 수 있습니다.1.
왼쪽의 + 버튼을 클릭하고 New WebSocket을 선택합니다.
2.
ws 또는 wss로 시작하는 WebSocket 서버 URL을 입력합니다.
4.
WebSocket 엔드포인트의 연결을 해제하려면 Disconnect를 클릭합니다.
최상의 경험과 WebSocket API의 전체 기능 세트를 활용하기 위해 Apidog 클라이언트 사용을 권장합니다.
메시지 보내기#
WebSocket 연결을 설정한 후 Message 탭에서 메시지를 작성할 수 있습니다.Text, JSON, XML, HTML과 같은 텍스트 형식으로 메시지를 직접 작성하는 것 외에도, Base64 또는 Hexadecimal을 사용하여 바이너리 형식으로 메시지를 작성할 수도 있습니다.편집기는 선택한 메시지 형식에 따라 메시지 내용에 구문 강조 표시를 적용합니다. 메시지가 JSON, XML 또는 HTML 형식인 경우 입력 내용을 서식화할 수도 있습니다.메시지 보기#
아래의 Messages 섹션에는 연결 상태, 보낸 메시지 및 받은 메시지가 시간순으로 표시됩니다.개별 메시지를 클릭하면 오른쪽에서 세부 정보를 볼 수 있습니다.텍스트 형식 메시지의 경우, 서식화된 메시지가 기본적으로 표시됩니다. 메시지 형식과 인코딩을 수동으로 전환할 수 있습니다.
바이너리 형식 메시지의 경우, 메시지의 Hexdump가 기본적으로 표시됩니다. Base64로 인코딩된 메시지와 원본 메시지도 볼 수 있습니다.
핸드셰이크 요청 매개변수 추가#
인증 또는 기타 복잡한 시나리오를 수용하기 위해 WebSocket 핸드셰이크 중에 필요한 Params, Headers, Cookies와 같은 매개변수를 사용자 지정할 수 있습니다.핸드셰이크 요청 매개변수는 연결이 설정된 후에는 수정할 수 없습니다. 연결을 설정하기 전 또 는 연결을 해제한 후에 구성해야 합니다.
변수 사용#
WebSocket 연결의 핸드셰이크와 메시지에서 Apidog 변수를 사용할 수 있습니다. 자세한 내용은 변수 사용을 참조하십시오.API 문서#
WebSocket API에 대해 status, responsible person, tags를 설정하고, Markdown 형식으로 자세한 API 설명을 제공할 수 있습니다.또한 WebSocket API 문서를 외부 팀과 공유할 수 있으며, 외부 팀은 브라우저에서 직접 해당 문서를 볼 수 있습니다.API 저장#
디버깅이 완료되면 Save 버튼을 클릭하여 WebSocket API를 HTTP 프로젝트의 디렉터리 트리에 저장합니다. 이를 통해 다른 팀 구성원이 API 문서를 디버깅하거나 볼 수 있습니다.FAQ#
Q: 응답 검증이 필요하지 않은 이유는 무엇입니까?A: WebSocket 요청의 경우 연결을 설정할 때 HTTP 상태 코드는 프로토콜 업그레이드가 성공했음을 나타내는 101이어야 합니다. 따라서 일반적으로 상태 코드를 검증할 필요가 없습니다.Q: Auth 탭이 없습니다. WebSocket API를 어떻게 인증할 수 있습니까?A: 현재 WebSocket API 인증에는 다음 두 가지 방법이 권장됩니다.1.
연결 설정 중 Param, Header 또는 Cookie 필드에 인증 정보를 전달합니다.
