APIリクエストが期待どおりに動作しない場合、Apidog は問題を迅速に診断し解決するための強力なデバッグツールを提供します。このガイドでは、Apidog Console を使用して問題をトラブルシューティングする方法と、一般的な問題およびその解決策について説明します。実際のリクエスト#
リクエストを送信した後、Actual Request タブに切り替えると、リクエストURL、ヘッダー、ボディなど、サーバーに実際に送信された内容の完全な詳細を確認できま す。このビューは、リクエストが送信される前に、変数、パラメータ、認証情報が正しく解決されていることを確認するのに特に役立ちます。さらに下へスクロールすると、さまざまなプログラミング言語を使用してこのリクエストを送信するためのクライアントコードも確認できます。これにより、アプリケーションで同じリクエストを実装する際に役立ちます。Console でのデバッグ#
リクエスト実行中の任意のタイミングでコンソールにログを出力でき、リクエストやスクリプト内の問題を特定するのに役立ちます。Apidog は以下のコンソールメソッドをサポートしています。変数の抽出、データベース操作、その他の自動プロセスは、その結果を自動的にコンソールへ出力するため、スクリプト実行の状況を可視化できます。
一般的な問題#
以下の表では、リクエスト送信時に発生する可能性のある一般的な問題と、その解決策を示します。| 問題 | 解決策 |
|---|
| 接続性 | Apidog がリクエストを送信できない場合、接続に問題がある可能性があります。確認するには、WebブラウザーでWebページを開いてみてください。 |
| ファイアウォール | 一部のファイアウォールは、ブラウザーからではない接続をブロックするように設定されている場合があります。この場合、Apidog が正常に機能するように、ネットワーク管理者に連絡する必要があります。 |
| プロキシ設定 | プロキシサーバーを使用してリクエストを送信している場合は、設定を確認してください。デフォルトでは、Apidog はオペレーティングシステムのネットワーク設定で構成されているプロキシ設定を使用します。Apidog Console は、プロキシサーバーに関するデバッグ詳細を提供します。 |
| SSL証明書 | HTTPS接続で問題が発生する場合があります。設定アイコンをクリックし、Settings > General に移動することで、Settings でSSL証明書の検証を無効にできます。それでも問題が解決しない場合、サーバーがクライアント側SSL接続を利用している可能性があります。これは、設定アイコンをクリックし、Settings > Certificates に移動することで設定できます。正しいSSL証明書がサーバーに送信されていることを確認するには、Apidog Console を使用してください。証明書の管理について詳しく確認してください。 |
| クライアント証明書 | APIサーバーでクライアント証明書が必要になる場合があります。設定アイコンをクリックし、Settings > Certificates に移動することで、Settings にクライアント証明書を追加できます。 |
| 不正なリクエストURL | リクエストで変数またはパスパラメータを使用している場合は、Postman Console を確認して最終的なアドレスが正確であることを再確認してください。Postman Console には、実行時にリクエストが送信されたURLが表示されます。未解決のリクエスト変数は、不正なサーバーアドレスにつながる可能性があります。 |
| 不正なプロトコル | URLで正しいプロトコル(http:// または https://)を使用していることを確認してください。 |
| 短いタイムアウト | Apidog で短いタイムアウトが設定されている場合、リクエストが完了前にタイムアウトし、エラーになる可能性があります。これを避けるには、設定アイコンをクリックし、Settings > General に移動して、Request timeout を増やしてください。 |
| 無効なレスポンス | サーバーがエンコーディングエラーや無効なヘッダーを含むレスポンスを送信した場合、Apidog はそれらの解釈に苦労する可能性があります。 |
| TLSバージョン | Apidog はTLSバージョン1.2以上をサポートしていますが、古いブラウザーやオペレーティングシステムとは互換性がない場合があります。 |
| Apidog のエラー | Apidog がAPIサーバーに不正なリクエストを送信している可能性があります。サーバーログにアクセスできる場合は、それを確認することで検証できます。この問題が発生している疑いがある場合は、GitHub issue tracker を通じて Apidog チームにお問い合わせください。 |
| 未解決の変数 | 未解決の変数とは、それが使用されているリクエストで利用可能なスコープ内に定義されていない変数です。 |
| CORS | Apidog Webアプ リケーションでリクエストの送信に問題が発生する場合、クロスオリジンリソース共有(CORS)エラーが原因である可能性があります。リクエストに適切な Apidog Agent を使用していることを確認してください。また、CORSの問題を回避するために Apidog Client を利用することもできます。 |
ほとんどのデバッグシナリオでは、Actual Request タブと Console により、APIリクエストの問題を特定して修正するために必要なすべての情報が得られます。