Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. リクエスト送信
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. リクエスト送信

WebSocket

WebSocketは、単一のTCP接続上で全二重通信を実現するAPI技術だ。従来のHTTPリクエストと比べて、遅延が少なく効率が高い。オンラインゲーム、リアルタイムチャットなど、永続的な接続やリアルタイムのデータ転送が必要なシーンに適している。
WebSocket APIの管理はApidog バージョン2.2.34以降でサポートされている。

WebSocket APIの作成#

HTTPプロジェクト内にWebSocket APIを作成できる。
1.
左側の「+」ボタンをクリックし、「新規WebSocket」を選択
2.
ws または wss で始まるWebSocketサーバーのURLを入力
3.
「接続」をクリック
4.
WebSocket APIを切断するには、「切断」をクリック
WebSocket APIの機能を最大限に活用するには、Apidogクライアントの使用を推奨する。

メッセージの送信#

WebSocket接続を確立後、メッセージタブでメッセージを作成できる。
Text、JSON、XML、HTMLなどのテキスト形式でメッセージを直接作成できるほか、Base64 や 16進数 を使用してバイナリ形式でメッセージを作成することもできる。
エディタは選択したメッセージ形式に基づいて、メッセージ内容の構文強調を適用する。メッセージが JSON、XML、HTML 形式の場合、入力内容のフォーマットも可能だ。

メッセージの表示#

下部のメッセージ セクションには、接続状態、送信メッセージ、受信メッセージが時系列で表示される。
個々のメッセージをクリックすると、右側に詳細が表示される:
テキスト形式のメッセージは、デフォルトでフォーマットされたメッセージが表示される。メッセージ形式とエンコーディングを手動で切り替えることができる
バイナリ形式のメッセージは、デフォルトでメッセージの Hexdump が表示される。Base64 でエンコードされたメッセージと元のメッセージも表示できる

Handshakeリクエストパラメータの追加#

認証やその他の複雑なシナリオに対応するため、WebSocketハンドシェイク時に必要な パラメータ、ヘッダー、Cookie などのパラメータをカスタマイズできる。
Handshakeリクエストパラメータは、接続確立後は変更できない。接続前または切断後に設定する必要がある。

変数の使用#

WebSocket接続のハンドシェイクやメッセージでApidogの変数を使用できる。詳しくは変数の使用を参照。

APIドキュメント#

WebSocket APIのステータス、担当者、タグ を設定し、Markdown 形式で詳細なAPI説明を提供できる。
また、WebSocket APIドキュメントを外部チームと共有でき、ブラウザで直接閲覧できる。

APIの保存#

デバッグが完了したら、『保存」ボタンをクリックしてWebSocket APIを HTTP プロジェクトのディレクトリツリーに保存する。これにより、他のチームメンバーがAPIのデバッグやドキュメントの閲覧ができる。

FAQ#

Q: レスポンスのバリデーションが不要なのはなぜ?
A: WebSocketリクエストでは、接続確立時にHTTPステータスコードが 101 である必要があり、これはプロトコルのアップグレードが成功したことを示す。そのため、通常ステータスコードの検証は不要だ。
Q: Authタブがないが、WebSocket APIの認証はどうする?
A: 現在、WebSocket API認証には2つの方法を推奨している:
1.
接続確立時に パラメータ、ヘッダー、Cookie フィールドで認証情報を渡す
2.
メッセージ内のフィールドに認証情報を含める
Q: ApidogはWebSocket APIでプリリクエスト/テストスクリプトとアサーションをサポートしている?
A: まだサポートしていないが、現在設計・開発中だ。
Q: リクエストとレスポンスの例はサポートされている?
A: 現在はサポートしていないが、将来のバージョンでの実装を検討中だ。
Q: WebSocket APIでモックがサポートされていないのはなぜ?
A: 現在のモックライブラリはWebSocket APIの定義をサポートしていないため、定義に基づいてメッセージボディを生成できない。
Previous
gRPC
Next
SSEデバッグ
Built with