APIのデバッグ/APICase
APIドキュメントが完了したら、APIのデバッグ(単体テスト)を始めることができます。
Postmanとは対照的に、ApidogはAPIの設計と実行のアイデアの区別をします。
- APIの設計：新しいAPIページとAPI 詳細設定ページは、APIを実行するためではなく、APIドキュメントを定義するために設計されています。したがって、これらのページはパラメータの値を設定するのではなく、APIの基本情報（パラメータ名やパラメータの説明など）を定義するためにのみ使用できます。パラメータ値、前処理Script、後処理Scriptなどを、APIの実行ページで設定してください。
- APIの実行：API 実行ページ（API 詳細設定ページからアクセス可能）は一時的なデバッグのために設計されています。実行後、パラメータ、前処理Script、後処理Scriptなどを保存するには、「APICase保存」をクリックしてください。そうしない場合、タブを閉じた後に情報がなくなります。
PostmanのようにAPIを事前設計せずに素早くデバッグする方法はありますか？ クイックRequest 機能を利用します。
新しいAPIを開くときに、タブが上書きされることを防止するにはどうすればいいですか？ タブをダブルクリックするか、ツリーメニューで当該項目をダブルクリックしてください。これはVSCodeと同じような操作です。タブの内容に変更があれば、タブが自動的に修正されます。
クイックスタート
APIの詳細設定に移動し、実行タブをクリックします。
APICaseを保存
「APICaseを保存」機能は、後で使用する必要があるか、他の人がAPIをデバッグすることを支援するために現在使用中の設定を保存する操作です。ユースケースを保存すると、それは左側のツリーメニューで表示されます。
- APIユースケースの保存は役に立つ機能です。実行するたびに常に保存することをお勧めします。その後、デバッグ目的で開発者がそれを効率的に再利用できます。
- APIには通常数多くのユースケースがあります。例えば、パラメータが正しい、パラメータが正しくない、パラメータが空です など、多数のユースケースがあります。
APIのパラメータ
APIのパスとパラメータ名は、手動入力を必要とせずに実行中にAPI 設計から自動的に読み込まれます。パラメータ値は、API 設計のデフォルトのサンプル値から自動的に読み込まれますが、手動で編集することも可能です。
パラメータを入力すると、「送信」をクリックして実行します。
Response
システムは、Responseを使用して、返されたデータがデータ構造内の指定のResponseに準拠しているかどうかを判断できます。これは、手動によるレビューより効率性が高くて高精度なので、手動で行う必要がなくなります。
データ構造の検証結果：
システムは、実行後に返されたデータが正しいかどうかを自動的にチェックし、選択したResponseの種類のデータ構造に基づいて詳細なエラーメッセージを返します。
アサーション
後処理操作は、アサーションをサポートします。 APIから返されたデータ（または応答時間）にアサーションを設定して、期待に応えるかどうかを判断できます。 ここからアサーションについてもっと詳しく見る。
変数の値の抽出
後処理は、変数の値の抽出をサポートします。APIが返したResponseからデータを抽出して、それを他のAPIが直接に利用可能な変数（ローカル変数、環境変数、グローバル変数）に設定できます。ここから変数の値の抽出に関するドキュメントを見る。
コンソール
コンソールはデバッグを支援するように設計されています。コンソールは、実行中にScriptのデバッグログとエラー情報を表示します。