メインコンテンツまでスキップ

WebSocket API

WebSocket APIは、双方向のリアルタイム通信を実現するためのプロトコルとAPIの組み合わせです。通常のHTTPリクエストとは異なり、クライアントとサーバーが接続を確立した後、両者がデータを相互に送受信するためのパーマネントな接続を提供します。

近年、API開発領域で、Restful APIは以前として主流になっていましたが、WebSocket APIが急速に流行になっていることにも気づいましたよね。その背後にある原因は以下のようなものがあります。

WebSocket APIがますます流行になっている原因​

  1. リアルタイムなWebアプリケーションの需要の増加： ユーザーがリアルタイムで情報を共有したり、他のユーザーと対話したりするアプリケーションの需要が高まっています。WebSocketは、リアルタイムなデータの双方向通信を容易に実現するため、このようなアプリケーションの開発に必要不可欠な技術となっています。
  2. WebSocketが広くサポートされるようになったこと：WebSocketは、近年ほとんどの主要なWebブラウザでサポートされるようになりました。また、WebSocketを利用するためのツールやライブラリも豊富に存在しているため、開発者が簡単に利用できるようになっています。
  3. 高速かつ効率的な通信が可能であること：WebSocketは、効率的なデータ転送が可能であり、低遅延の双方向通信が実現できます。これにより、リアルタイムな情報の更新やイベントの通知など、高速かつ効率的な通信が必要なアプリケーションで広く利用されています。
  4. スケーラビリティが高いこと：WebSocketは、多数のクライアントとの同時接続をサポートしています。これにより、大規模なリアルタイムアプリケーションやチャットアプリケーションなど、多数のユーザーを同時に処理する必要がある場合にもスケーラブルなソリューションを提供します。

以上のような理由から、WebSocket APIは現在広く利用されており、今後もさらに普及していくと予想されます。

ApidogがWebSocket APIへの対応が開始​

WebSocketは、比較的新しい技術であり、Restful APIに比べて普及が進んでいるとは言い難いです。そのため、開発ツールの提供も遅れています。このようなバックグランドで、Apidogは、バージョン2.2.34のリリースに伴い、WebSocket APIへの対応が始まりました。

Apidogの最新バージョン 2.2.34では、プロジェクト管理画面で「+」ボタンをクリックし、WebSocket APIを新規作成することができるようになりました。WebSocketエンドポイントを入力するだけで、接続が確立され、リアルタイムにメッセージを送受信できます。

ApidogでWebSocket APIを新規作成

操作ガイド：４ステップでWebSocket APIをデバッグしたりする​

ステップ⒈接続を確立する​

WebSocketは、簡単なハンドシェイクプロセスを通じて接続を確立します。Apidogを使用して、アドレスバーにエンドポイントとなるURLを入力し、「接続」ボタンをクリックしてサーバーとのハンドシェイクを完了し、WebSocket接続を確立することができます。

img

また、認証やその他の複雑なシナリオを満たすために、パラメータ、ヘッダー、クッキーなど、ハンドシェイク中に渡す必要があるパラメータをカスタマイズすることもできます。

ステップ⒉メッセージの送受信をする​

接続が確立されたら、「Message」タブの下にメッセージを書くことができます。テキスト、JSON、XML、HTML、その他のテキスト形式のメッセージを直接に書くことに加えて、バイナリ形式のメッセージはBase64または16進数を使用して書くことにも対応できます。メッセージを「送信」すると、レスポンスをすぐ取得することができます。

Apidogは、接続ステータス、送信メッセージ、受信メッセージを新着順に表示する新しいタイムラインビューを提供します。あるメッセージをクリックすると、その詳細情報を簡単に表示できます。

ApidogでWebSocket APIの送受信をする

ステップ⒊WebSocket API仕様書を書く​

Apidogの優れたドキュメンテーション機能は、WebSocket APIでも利用できます。WebSocket APIの状態、責任者、およびタグを設定し、Markdown形式で詳細な説明を入れることで仕様書を簡単に作成することができます。

ApidogでWebSocket API仕様書作成

もちろん、WebSocket APIの仕様書を作成すると、それを外部チームと共有したり、ブラウザで直接表示したりすることもできます。

ステップ⒋WebSocket APIを保存する​

デバッグした後、「保存」ボタンをクリックしてWebSocket APIを現在のプロジェクトに保存することができます。その後、他のチームメンバーが当該APIにアクセスしたり、デバッグしたりすることができるようになります。

ApidogでWebSocket APIを保存

FAQ​

  • 応答検証がないのはなぜですか?

WebSocket リクエストが接続を確立すると、HTTP ステータス コードは通常「101」になり、プロトコルがアップグレードされたことを示します。 したがって、ステータス コードを検証することはあまり意味がありません。

  • 「認証」タブがない場合、 WebSocket API を認証するにはどうすればよいですか?

現在、WebSocket API 認証には 2 つの方法が推奨されています。

  1. 接続を確立するときに、Param、Header、または Cookie のフィールドに認証情報を渡します。
  2. メッセージを送信するときに、メッセージのフィールドに認証情報を渡します。

  • Apidog の WebSocket は、前後のスクリプトとアサーションをサポートしていますか?

    まだサポートされていないんですが、設計と開発中です。

    リクエストとレスポンスの例はサポートされていますか?

    いいえ、サポートする予定があります。

    モックがないのはなぜですか?

    現在、WebSocket APIの定義はサポートされていないため、定義に基づいてメッセージ本文を生成できません。 今後サポートする予定です。