デバッグ
インターフェースを開発した後は、APIデバッグを使用して機能を迅速に検証します。 機能は、リクエストアドレス、リクエストエリア、およびレスポンスエリアの3つの主要な領域に分かれています。
リクエストアドレス
メソッド:さまざまなメソッドリクエストメソッドのドロップダウン選択をサポートしています。 URL:アドレスバーに直接インターフェースのリクエストアドレスを入力できます。 プロトコル:現在、http1.1およびhttp2プロトコルの送信をサポートしています。
リクエストエリア
インターフェースのリクエストヘッダー、クエリ、およびその他の入力パラメータを視覚的に定義できます。共通パラメータ機能を使用して、プロジェクト全体に共通のパラメータを迅速に設定できます。
ヘッダー
ヘッダー入力パラメータ:一般的なヘッダーパラメータ名を迅速に検索してリクエストパラメータ値を入力できます。
クエリ
クエリ入力パラメータ:設定されたクエリパラメータ値は自動的にURLアドレスに追加されます。パラメータ値が空の場合に"="記号を追加するかどうかは、"="の設定を通じて定義できます。
ボディ
複数のデータ形式をサポート:none
、form-data
、x-www-form-urlencoded
、binary
、msgpack
、raw (json/xml/javascript/plain/html)
。
- none:リクエストボディはありません。
- form-data:ファイルのアップロードとコンテンツタイプの選択をサポートします。フォームをファイルで送信する必要がある場合は、form-dataに切り替えてください。
- urlencode (x-www-form-urlencoded):フォームを送信する必要がある場合は、urlencodeに切り替えてください。
- binary:バイナリファイルをアップロードする必要がある場合
- msgpack
定義されたスキーマに基づいて値を生成します。
- raw:JSONオブジェクトやその他のオブジェクトを送信する必要がある場合は、対応するrawタイプに切り替えてください。
- raw (json/xml)、jsonまたはxmlの階層インターフェースパラメータのスキーマ編集をサポートします。
定義されたスキーマに基づいて値を生成します。
- raw (javascript/plain/html):パラメータ値を設計するためのソースコード編集をサポートします。
パス
{}
または:
を使用してパスに変数を追加することで、RESTful APIデザインをサポートします。これらの変数は入力パラメータで表示されます。
認証
Bearerトークン、Basic認証、Digest認証、OAuth 1.0、Hawk認証、AWS Signature、NTLM認証(ベータ版)、Akamai EdgeGridなど、他の認証方法をサポートしています。
Cookie
クッキーのリクエストコンテンツを直接入力することをサポートしています。
事前リクエスト/事後レスポンス
リクエストが送信される前に事前リクエスト操作が発生します。これらの操作はカスタムスクリプトとデータベース接続をサポートし、入力パラメータの設定やデータの印刷によく使用されます。
リクエストが送信された後に事後レスポンス操作が発生し、通常は変数の設定やアサーションの作成に使用されます。これらはカスタムスクリプト、データベース接続、および変数の抽出をサポートしています。
- ドラッグソート、名前の変更、削除をサポート
- このタスクを実行するかどうかを示すスイッチ
レスポンスエリア
リアルタイムレスポンス
レスポンスボディ&テスト結果
レスポンスヘッダー
レスポンスクッキー
実際のリクエスト
コンソール
コンソールは、事前リクエストおよび事後レスポンススクリプトによって出力されたコンテンツを表示できます。
プロキシとレスポンス時間
システム設定でプロキシを構成している場合、その効果をレスポンスエリアで確認できます。さらに、プロキシの使用方法に関する詳細な手順については、ドキュメントを参照してください。
各イベントの期間を表示するには、レスポンス時間をクリックしてください:
リクエスト: リクエストの送信からソケット操作の開始までの時間。 ソケット: ソケット操作の期間。 ルックアップ: DNSクエリにかかった時間。 接続: サーバーへの接続の確立に必要な時間。 SecureConnect: SSLセキュア接続の確立にかかる時間。 レスポンス: サーバーからのレスポンスを受信する時間。 終了: リクエストの完了にかかった時間。 完了: リクエスト処理全体の合計時間。
これらの時間指標は、ネットワークリクエストのパフォーマンスを分析し、最も時間がかかっている段階を特定するのに役立ちます。特定の段階が遅いと判断された場合、さらなる最適化が必要です。