Apidog CLIは長年にわたり、ターミナル、CIパイプライン、自動化ワークフロー、または外部システムからAPIテストを実行するためのコマンドラインエントリポイントとして機能してきました。
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>その基盤は今も重要です。チームは依然として、APIテストを実行し、レポートを生成し、CI内で品質ゲートを維持するための信頼できる方法を必要としています。しかし、API開発は変化しています。現在、AIエージェントがAPI設計、テスト生成、デバッグ、移行、およびメンテナンスに参加しています。
これらのワークフローにおいて、CLIは既存のテストを実行する最終ステップであるだけでは不十分です。エージェントがAPIアセットを読み取り、テストアセットを作成または更新し、構造化された変更を検証し、それらを書き戻し、結果を確認するための安定した方法を提供する必要もあります。
アップグレードされたApidog CLIは、元のテスト実行基盤を維持し、それを開発者、スクリプト、およびAIエージェントのためのワークフローレイヤーに拡張します。この記事では、AIエージェント時代にCLIがなぜより重要になるのか、Apidog CLIで何が変わったのか、そしてAPIテスト自動化のためにチームがどのように使い始めることができるのかを説明します。
AIエージェント時代にCLIがより重要になる理由
グラフィカルインターフェースは人間向けに設計されています。視覚的で柔軟性があり、探索に役立ちます。しかし、AIエージェントは、構造化されたコマンド、予測可能な入力、予測可能な出力、および明確な検証ステップで最も効果的に機能します。
そこにCLIの重要性があります。CLIは、開発者がApidogで管理するのと同じリソース（API、環境、変数、テストケース、テストシナリオ、テストスイート、レポート、インポート/エクスポートデータなど）に対して、エージェントとスクリプトに再現可能なインターフェースを提供します。
実際には、これはApidogが人間のユーザーと自動化されたワークフローの両方に役立つことを意味します。人々は製品インターフェースで設計、デバッグ、レビュー、共同作業を継続します。エージェントと自動化は、CLIを使用して同じアセットに関する制御された操作を実行できます。
apidog run から完全なAPIおよびテストワークフローへ
以前のCLIエクスペリエンスは、主にテスト実行に焦点を当てていました。そのため、apidog run はCI品質ゲートとして有用でしたが、CLIがワークフローのほぼ終盤に登場することを意味していました。アップグレードされたCLIは、より多くのApidogコアリソースをカバー範囲に含めることで、自動化がより早く参加できるようになりました。具体的には、プロジェクトコンテキストの読み取り、テストアセットの準備、構造化された変更の検証、そして検証の実行です。
アップグレードされたCLIにより、ユーザーとエージェントは次のようなリソースを操作できます。
- プロジェクトおよびプロジェクトメタデータ
- APIおよびAPI定義
- 環境および変数
- テストケース
- テストシナリオ
- テストスイート
- レポート
- インポートおよびエクスポートワークフロー
- アカウント、ブランチ、ランナー、および関連するプロジェクトリソース
これにより、Apidog CLIの役割が変わります。単に他のすべてが完了した後にテストを実行する方法ではなくなりました。エージェントがプロジェクトを理解し、テストアセットを生成または更新し、変更を検証し、検証を実行する必要がある開発ループのより早い段階で参加できるようになりました。
エージェント主導型テストのためのより安全なループ
AIエージェントがAPI開発やテストを支援する場合、リスクの高い部分はコンテンツを生成することだけではありません。リスクの高い部分は、生成されたコンテンツを、十分な構造や検証なしに実際のプロジェクトに書き込むことです。
アップグレードされたCLIは、より安全なループを可能にします。
このループが重要なのは、多くのApidogリソースが構造化されているためです。テストケースやテストシナリオには、リクエストデータ、アサーション、変数抽出、プリプロセッサ、ポストプロセッサ、ステップ順序、環境への参照、その他の詳細が含まれる場合があります。エージェントが構造を推測した場合、小さな間違いが書き込みの失敗、UIでの不完全な表示、または期待どおりに動作しないテストにつながる可能性があります。
そのため、cli-schema はアップグレードの重要な部分です。複雑なJSONファイルをApidogに書き込む前に、エージェントはCLIに、フィールドと構造が期待されるスキーマと一致するかどうかを検証するように依頼できます。
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonつまり、エージェントに生成させますが、書き込みが行われる前にCLIに検証させます。
CLIは、コマンド出力でエージェント指向のヒントを提供することもできます。リソースが作成または更新された後、次のステップが「停止」であることはめったにありません。より信頼性の高いエージェントは、保存されたリソースを読み戻し、構造を確認し、適切な場合にテストを実行する必要があります。これらのヒントは、エージェントが盲点なくワークフローを進むのに役立ちます。
スキルはエージェントに操作判断を与える
CLIコマンドはエージェントに実行能力を与えます。スキルはエージェントに操作判断を与えます。
SKILLは単なるコマンドリファレンスではありません。AIエージェントのために書かれた操作ガイドに近いものです。いつコマンドを使用するか、どのコマンドを最初にすべきか、どのフィールドを推測すべきでないか、いつ検証するか、いつ読み戻すか、いつテストを実行するか、といった内容です。
たとえば、信頼性の高いエージェントは、常に大規模なテストシナリオをゼロから手書きすべきではありません。より安全なパターンは、多くの場合次のとおりです。
- 基本的なシナリオを作成する。
- APIまたは既存のテストケースからステップをインポートする。
- 完全なシナリオ構造を読み戻す。
- アサーション、変数抽出、またはプロセッサをより小さなステップで更新する。
- シナリオを検証して実行する。
スキルはこれらのパターンを明確にします。これにより、エージェントは、誤ったフィールド名を使用する、誤った列挙値を選択する、スキーマ検証をスキップする、または書き込みが成功したからといって最終的なリソースがすでに正しいと仮定するなどの一般的な間違いを回避できます。
Apidogは、エージェントがCLIコマンド、リソース構造、およびタスクワークフローを理解するのに役立つ8つの補助スキルを提供します。CLIとスキルが連携することで、ApidogはAIアシストによるAPI開発とテストにとってより実用的になります。
AIブランチによるより安全なプロジェクト変更
エージェントがプロジェクトリソースを変更する場合、安全性とレビュー可能性が重要です。そのため、アップグレードされたCLIは、AIブランチ と組み合わせて使用することもできます。
エージェントはまず、隔離されたブランチで変更を行います。チームは差分を確認し、結果を承認してから、ターゲットブランチにマージできます。これにより、自動化された変更がメインブランチや共有コラボレーションブランチに直接影響を与えるのを防ぐことができます。
実際のワークフローでこれがもたらすもの
アップグレードされたCLIの価値は、具体的なワークフローで最も容易に理解できます。
API定義からのテスト生成
エージェントは、プロジェクトからAPI定義を読み取り、テストケースを生成し、生成されたJSONを cli-schema で検証し、テストケースをApidogに書き込み、それらを読み戻し、検証を実行できます。これにより、テスト生成は一時的な提案から制御されたワークフローへと変わります。
複雑なテストシナリオのメンテナンス
多段階のシナリオの場合、エージェントはまずAPIまたは既存のテストケースからステップをインポートし、完全な構造を読み戻した後で、アサーション、変数、またはプロセッサを更新できます。これにより、大規模なシナリオを一度に誤って構築するリスクが軽減されます。
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailプロジェクトアセットの移動と再現
アップグレードされたCLIは、Apidogネイティブデータのインポートおよびエクスポートワークフローも改善します。これは、プロジェクトの移行、顧客環境の再現、テスト設定のコピー、またはプロジェクト間でのAPI、スキーマ、テストケース、シナリオの移動に役立ちます。
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonCI品質ゲートの維持
新しいエージェント対応機能はCIを置き換えるものではありません。それらを補完します。チームは依然として apidog run を自動テスト実行とレポートのコアエントリポイントとして使用できます。
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reports始めに
すでにApidog CLIがインストールされている場合は、まず現在のバージョンを確認してください。
apidog -vApidog CLIのバージョンが2.2.5より前の場合は、新機能を使用する前にCLIを更新してください。このバージョン番号はApidogアプリではなく、Apidog CLIを指します。
使用しているAIエージェントに、以下のプロンプトをコピーして、Apidog CLIと付属スキルを両方インストールするように依頼できます。
指示を読み、Apidog CLIのインストールを手伝ってください:
https://apidog.com/apidog-cli-installation-guide.md手動でインストールまたは更新したい場合は、次を実行してください。
npm install -g apidog-cli@latestコマンドの完全なリファレンスについては、Apidog CLIオプションを参照してください。
最初のAgentタスクを試す
CLIとスキルがインストールされたら、最も簡単な開始方法は、Agentに小さくリスクの低いAPIタスクを1つ与えることです。たとえば、Apidogプロジェクトに単純なヘルスチェックエンドポイントを作成するよう依頼し、その後それを読み戻して結果を確認させます。
このプロンプトをAIエージェントにコピーしてください。
Apidog CLIを使って、Apidogで最初のAPIエンドポイントを作成するのを手伝ってください。まず、Apidog CLIの設定を確認し、アクセス可能なプロジェクトを一覧表示してください。どのプロジェクトを使用するか私に尋ねてください。私が確認した後、シンプルなGET /health エンドポイントを「Health Check」という名前で、200のレスポンス例を付けて作成してください。書き込み前に構造化された入力をすべて検証し、その後エンドポイントを読み戻して、何が作成されたかを要約してください。これにより、新規ユーザーは具体的な出発点を得られます。エージェントが設定を確認し、プロジェクトに書き込む前に尋ね、小さなAPI定義を作成し、保存された結果を確認します。
次のステップ：
- 1つのワークスペースでAPIを設計、デバッグ、テスト、文書化するためにApidogをダウンロードしてください。
- コマンドラインAPIテスト、CI自動化、およびAIエージェントワークフローについては、Apidog CLIの詳細をご覧ください。
よくある質問
Apidog CLIとは何ですか？
Apidog CLIは、APIテストの実行、Apidogプロジェクトリソースの操作、ApidogのAPIおよびテストアセットと自動化ワークフローの接続に使用するコマンドラインツールです。
Apidog CLIはCIでAPIテストを実行できますか？
はい。チームはCIパイプラインで apidog run を使用して、APIテストを実行し、レポートを生成し、テストワークフローに自動品質ゲートを維持できます。
Apidog CLIはAIエージェントにどのように役立ちますか？
Apidog CLIは、AIエージェントがAPI情報を読み取り、テストアセットを生成または更新し、変更を検証し、それらをApidogに書き込み、結果を読み戻し、検証のためにテストを実行するための構造化された方法を提供します。
Apidog CLIの cli-schema とは何ですか？
cli-schema は、複雑なJSONファイルがApidogに書き込まれる前に検証するのに役立ちます。これにより、エージェントがテストケースやテストシナリオを作成または更新する際の書き込み失敗、無効なフィールド、および不要な再試行ループが減少します。
Apidog CLIをインストールするにはどうすればよいですか？
AIエージェントにApidog CLIのインストールガイドに従ってCLIと付属スキルを両方インストールするように依頼するか、npm install -g apidog-cli@latest を使用して手動でインストールできます。