Socket.IO

Socket.IOは、クライアントとサーバー間で低遅延の双方向かつイベントベースの通信を可能にするライブラリです。

新しいSocket.IO APIの作成

Apidogのバージョンは2.7.0以上である必要があります。

新しいSocket.IO APIを作成

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

New Socket.IOをクリックします。

サーバーアドレスを入力

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

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

接続を確立

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

イベントのリスニング

Eventsタブを開き、リスニングしたいイベント名を入力します（例：new message）。特定のイベントに対してListenを無効にすると、そのイベントのメッセージは受信されなくなります。

イベントリスニングルール：

デフォルトでは、システムはmessageイベントをリスニングします。

イベントの追加や削除は、既存の接続に影響を与えません。

イベント名を変更すると、自動的に元のイベントのリスニングが停止します。

メッセージの送信

イベントと引数

イベントと引数の設定

イベント： デフォルトはmessageですが、カスタマイズ可能です（例：new message）。

引数： JSON、テキスト、バイナリをサポートしています。

メッセージを送信

Sendボタンをクリックします。

記録を確認

タイムラインでイベントタグ付きの送信記録を確認します。

Ack (肯定応答)

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

複数の引数

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

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

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

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

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

設定エントリ

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

クライアントバージョン

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

ハンドシェイクパス

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

変数の使用

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

APIの保存

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

APIドキュメントの生成

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

よくある質問

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

チェックリスト：

サーバーが稼働していることを確認します。

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

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

すべての引数を受信していない？

ACKがトリガーされない？

新しいSocket.IO APIの作成#

イベントのリスニング#

メッセージの送信#

イベントと引数#

Ack (肯定応答)#

複数の引数#

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

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

変数の使用#

APIの保存#

APIドキュメントの生成#

よくある質問#