Socket.IO

Socket.IO は、クライアントとサーバー間で低遅延、双方向、イベントベースの通信を可能にするライブラリです。WebSocket 接続を介してリアルタイムの双方向通信チャネルを提供し、WebSocket が利用できない場合は HTTP ロングポーリングへ自動的にフォールバックします。

前提条件

Apidog バージョン 2.7.0 以降

Socket.IO サーバーエンドポイント（ws:// および wss:// プロトコルをサポート）

Socket.IO エンドポイントの作成

新しい Socket.IO エンドポイントを作成する

プロジェクトの左側パネルにある 「+」 ボタンにカーソルを合わせます

「New Socket.IO」 をクリックします

サーバーアドレスを入力する

サーバーアドレスを入力します（例：ws://localhost:3000）

ws:// と wss:// の両方のプロトコルをサポートしています

接続を確立する

「Connect」 ボタンをクリックしてサーバーに接続します

イベントのリッスン

Events タブを開き、リッスンしたいイベント名を入力します（例：new message）。特定のイベントの Listen を無効にすると、そのイベントのメッセージの受信を停止できます。

イベントリッスンのルール

ルール	説明
デフォルトイベント	システムはデフォルトで `message` イベントをリッスンします
動的な変更	イベントを追加または削除しても、既存の接続には影響しません
イベント名の変更	イベント名を変更すると、元のイベントのリッスンは自動的に停止します

メッセージの送信

イベントと引数

イベントと引数を設定する

Event: デフォルトは message ですが、カスタマイズできます（例：new message）

Argument: JSON、テキスト、Binary 形式をサポートしています

メッセージを送信する

「Send」 ボタンをクリックします

レコードを表示する

イベントタグ付きの送信レコードをタイムラインで確認します

確認応答（Ack）

Ack オプションを有効にすると、サーバーはリクエストを受信して処理した後、コールバックメッセージを返します。

複数の引数

「+ Add Argument」 をクリックして、追加の引数を含めます。

複数の引数を含むメッセージを送信すると、タイムラインには 「x Args」 のようなラベルが表示されます。それをクリックすると展開され、すべての引数を表示できます。詳細を確認するには、右側のタブを切り替えます。

ハンドシェイクリクエストパラメータ

リクエストパラメータは、URL、Params、Headers、または Cookies に含めることができます。

クライアントバージョンとハンドシェイクパス

設定項目

Request の下にある Settings に移動します

クライアントバージョン

デフォルトは v4 です。サーバーが古いバージョン（例：v2/v3）を使用している場合は、クライアントバージョンを手動で切り替えます

ハンドシェイクパス

デフォルトは /socket.io です。サーバーがカスタムパス（例：/custom）を使用している場合は、それに応じてパスを更新します

変数の使用

Apidog では、引数に変数を含めることができます。メッセージを送信すると、これらの変数は実際の値に自動的に置き換えられます。

エンドポイントの保存

デバッグが完了したら、「Save」 ボタンをクリックして、Socket.IO エンドポイントを HTTP プロジェクトのフォルダーツリーに保存します。これにより、チームメンバーがエンドポイントのアクセス、デバッグ、ドキュメントの閲覧を簡単に行えるようになり、コラボレーションと効率が向上します。

エンドポイントドキュメントの生成

Socket.IO エンドポイントの status を設定し、maintainer を割り当て、関連する tags を追加することで、簡単に管理できます。また、Markdown を使用して詳細な説明を記述することもできます。Apidog を使用すると、オンライン API ドキュメントを生成し、その URL をチームと共有してシームレスに共同作業できます。

FAQ

接続に失敗した場合はどうすればよいですか？

チェックリスト:

サーバーが実行中であることを確認します

クライアントバージョンがサーバーと互換性があることを確認します

ファイアウォールが必要なポートをブロックしていないことを確認します

すべての引数を受信できませんか？

ACK がトリガーされませんか？

前提条件#

Socket.IO エンドポイントの作成#

イベントのリッスン#

イベントリッスンのルール#

メッセージの送信#

イベントと引数#

確認応答（Ack）#

複数の引数#

ハンドシェイクリクエストパラメータ#

クライアントバージョンとハンドシェイクパス#

変数の使用#

エンドポイントの保存#

エンドポイントドキュメントの生成#

FAQ#