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 に ステータス、担当者、タグ を設定し、Markdown 形式で詳細な API 説明を記述できます。WebSocket API ドキュメントを外部チームと共有することもでき、外部チームはブラウザーで直接表示できます。API の保存#
デバッグが完了したら、「Save」 ボタンをクリックして、WebSocket API を HTTP プロジェクトのディレクトリツリーに保存します。これにより、他のチームメンバーが API ドキュメントをデバッグまたは表示できるようになります。FAQ#
WebSocket リクエストでは、接続を確立する際に HTTP ステータスコードが 101 である必要があり、これはプロトコルアップグレードが成功したことを示します。そのため、通常、ステータスコードを検証する必要はありません。
