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

APIデバッグ機能の紹介

APIのデバッグは、APIが開発中に単体テストを行うことになります。APIのデバッグは、開発者がコード中のエラーを特定して修復することに役立ちます。

デバッグを行う方法

APIのデバッグ、つまりAPIの単体テストを行うために、次の手順が必要です。

APIを選択して、「実行」ページにアクセスします。

apidog

必須のRequestパラメータを入力して、「送信」ボタンをクリックします。

apidog

ここでレスポンスを取得することができますので、それを保存して再利用にすることができます。

デバッグの環境の設定

プロジェクトは違う階段で、違う環境を必要とする可能性があります。例えば、開発環境、テスト環境、本番環境などがあります。これらの環境には、違うサービスとAPIパラメータ値を持っています。環境管理機能は、環境の変更によって発生する問題を効果的に解決できます。

デバッグモード

デバッグモードは、APIパラメータをデバッグしてからAPI仕様書を生成する習慣があるユーザーに適しています。デバッグモードで、開発者は、APIのパラメータを変更することがある場合、直ちにRequestを送信して、仕様書を生成できます。

apidog

Requestの利用

Requestは、外部のAPIをデバッグしたいする時によく使われています。API仕様書を作成しなくても、Requestを送信してレスポンスを取得できます。

apidog