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

設計

EchoAPIでWebSocketインターフェースドキュメントを設計/プレビュー​

EchoAPIでは、WebSocketの迅速なデバッグ（ドキュメント参照）が可能なだけでなく、デバッグ中のデータを迅速にWebSocketインターフェースドキュメントとして生成することもできます。タブをデザインページに切り替えるだけで済みます。

直接WebSocketインターフェースドキュメントを設計することもでき、以下の手順に従って行います。

image.png

ステップ1：新しいリクエストを作成​

EchoAPIを開き、左側のメニューにある「+」ボタンをクリックして新しいリクエストを作成します。
リクエストタイプのドロップダウンメニューからWebSocketを選択します。

image.png

ステップ2：WebSocketの基本情報を設定​

URLボックスにWebSocketサーバーのURLを入力します。例：wss://echo.websocket.org

  • 実際のWebSocketサーバーのアドレスとポートに置き換えてください。
  • ws:// または wss:// で始まるアドレスを使用することに注意してください。

WebSocketにタグを付けたり、テキスト説明を追加したり、拡張属性フィールドを追加することもできます（ドキュメント参照）。

image.png

ステップ3：WebSocketのリクエストパラメータ情報を設定​

WebSocketに接続するためのリクエストヘッダー、リクエストパラメータ、およびその他の設定条件を設定できます。

image.png

ステップ4：ドキュメント生成のためにWebSocketメッセージフローを設計​

ここでWebSocketメッセージのリクエストとレスポンスの内容を設計できます。

image.png

その他：デバッグ中に保存したレスポンスの例も表示されます​

レスポンスエリアでは、現在のレスポンス内容を特定のメッセージのレスポンス例として迅速に保存できます。これにより、より完全なインターフェースドキュメントを生成できます（ドキュメント参照）。

image.png

image.png

image.png