Apidog CLI は、ターミナルまたは CI/CD パイプラインから自動テストを実行し、Apidog プロジェクトリソースを管理するために使用します。テストの実行、API 設計リソースの管理、環境と変数、インポートとエクスポート、ドキュメント公開、ブランチ共同作業、プロジェクト管理をサポートしています。Apidog CLI の基本構文#
ほとんどのプロジェクトリソースコマンドでは、プロジェクトを指定するために --project <projectId> を使用します。特定のブランチで操作するには、--branch <branchName> を使用できます。--branch を省略した場合、サーバーはデフォルトブランチを使用します。プライベートプロジェクトにアクセスする前に、ログインするかアクセストークンを指定してください。| コマンド | 説明 | 例 |
|---|
login | アクセストークンでログインし、ローカルに保存します。 | apidog login --with-token <token> |
logout | ログアウトし、保存済みのローカルトークンを削除します。 | apidog logout |
whoami | 現在認証されているユーザーの情報を表示します。 | apidog whoami |
コマンド実行時にトークンを直接渡すこともできます。GitHub Actions を使用している場合は、アクセストークンをリポジトリの Settings --> Secrets and Variables --> Actions --> Repository variables に保存できます。その後、${{ vars.APIDOG_ACCESS_TOKEN }} を使用して参照できます。
CLI スキーマ#
複雑なリソースを作成または更新する前に、cli-schema を使用して JSON ファイルを確認および検証します。これにより、不正な形式のデータによるリクエスト失敗を減らすことができます。| コマンド | 説明 | 例 |
|---|
cli-schema list | CLI でサポートされているすべてのスキーマキーを一覧表示します。 | apidog cli-schema list |
cli-schema get | コマンドデータファイル用の JSON Schema を出力します。 | apidog cli-schema get endpoint-create |
cli-schema validate | ローカル JSON ファイルをスキーマキーに照らして検証します。 | apidog cli-schema validate endpoint-create --file ./endpoint.json |
スキーマキーは通常、endpoint-create、test-scenario-update、merge-request-create のように、コマンドパスとアクションを組み合わせたものです。チームとプロジェクト#
チームおよびプロジェクトのコマンドは、CLI を通じてリソースを管理するための出発点です。プロジェクトレベルのコマンドで必要な ID を確認するために使用します。チーム管理#
| コマンド | 説明 | 例 |
|---|
team list | 現在のアカウントからアクセス可能なチームを一覧表示します。 | apidog team list |
team get | 特定のチームの詳細を表示します。 | apidog team get <teamId> |
プロジェクト管理#
| コマンド | 説明 | 例 |
|---|
project list | 現在のアカウントからアクセス可能なプロジェクトを一覧表示します。 | apidog project list |
project get | プロジェクトの詳細を表示します。 | apidog project get <projectId> |
project create | チーム配下にプロジェクトを作成します。 | apidog project create --team <teamId> --name "New Project" |
プロジェクト設定#
| コマンド | 説明 | 例 |
|---|
project settings get | プロジェクトレベルの設定を表示します。 | apidog project settings get --project <projectId> |
project settings update | JSON ファイルを使用してプロジェクト設定を更新します。 | apidog project settings update --project <projectId> --file ./project-settings.json |
cli-schema get project-settings-update | プロジェクト設定更新用のスキーマを表示します。 | apidog cli-schema get project-settings-update |
環境と変数#
これらのコマンドを使用して、API デバッグおよび自動テストで使用する実行時環境、グローバル変数、チーム変数を管理します。環境管理#
| コマンド | 説明 | 例 |
|---|
environment list | プロジェクト内の環境を一覧表示します。 | apidog environment list --project <projectId> |
environment get | ベース URL などの環境詳細を表示します。 | apidog environment get <environmentId> --project <projectId> |
environment create | 環境を作成します。 | apidog environment create <name> --project <projectId> --base-url <url> |
environment update | 環境を更新します。 | apidog environment update <environmentId> --project <projectId> --file ./environment.json |
environment delete | 環境を削除します。 | apidog environment delete <environmentId> --project <projectId> |
cli-schema get environment-update | 環境更新用のスキーマを表示します。 | apidog cli-schema get environment-update |
変数管理#
| コマンド | 説明 | 例 |
|---|
variables list | スコープ別に変数を一覧表示します。 | apidog variables list --project <projectId> --scope global |
variables get | 変数の値を表示します。 | apidog variables get --project <projectId> --scope global --key <key> |
variables set | 変数を作成または更新します。 | apidog variables set --project <projectId> --scope global --key <key> --value <value> |
variables delete | 変数を削除します。 | apidog variables delete --project <projectId> --scope global --key <key> |
variables import | ローカルファイルから変数をインポートします。 | apidog variables import --project <projectId> --scope global --file ./variables.json |
variables export | 変数をローカルファイルにエクスポートします。 | apidog variables export --project <projectId> --scope global --output ./variables.json |
API 設計リソース#
これらのコマンドを使用して、HTTP API エンドポイント、スキーマ、フォルダー、モックルール、共通パラメータ、レスポンスコンポーネント、セキュリティスキームなどの API 設計リソースを管理します。複雑なリソースを作成または更新する場合は、事前に cli-schema get <schemaKey> と cli-schema validate <schemaKey> --file <path> を実行することをお勧めします。HTTP API エンドポイント#
| コマンド | 説明 | 例 |
|---|
endpoint list | プロジェクト内の HTTP API エンドポイントを一覧表示します。 | apidog endpoint list --project <projectId> |
endpoint get | エンドポイントの詳細を表示します。 | apidog endpoint get <endpointId> --project <projectId> |
endpoint create | JSON ファイルからエンドポイントを作成します。 | apidog endpoint create --project <projectId> --file ./endpoint.json |
endpoint update | エンドポイントを更新します。 | apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json |
endpoint delete | エンドポイントを削除します。 | apidog endpoint delete <endpointId> --project <projectId> |
cli-schema get endpoint-create | エンドポイント作成用のスキーマを表示します。 | apidog cli-schema get endpoint-create |
cli-schema get endpoint-update | エンドポイント更新用のスキーマを表示します。 | apidog cli-schema get endpoint-update |
データスキーマ#
| コマンド | 説明 | 例 |
|---|
schema list | プロジェクト内のデータスキーマを一覧表示します。 | apidog schema list --project <projectId> |
schema get | スキーマの詳細を表示します。 | apidog schema get <schemaId> --project <projectId> |
schema create | JSON ファイルからデータスキーマを作成します。 | apidog schema create --project <projectId> --file ./schema.json |
schema update | データスキーマを更新します。 | apidog schema update <schemaId> --project <projectId> --file ./schema.json |
schema delete | データスキーマを削除します。 | apidog schema delete <schemaId> --project <projectId> |
cli-schema get schema-create | データスキーマ作成用のスキーマを表示します。 | apidog cli-schema get schema-create |
cli-schema get schema-update | データスキーマ更新用のスキーマを表示します。 | apidog cli-schema get schema-update |
Markdown ドキュメント#
| コマンド | 説明 | 例 |
|---|
doc list | Markdown ドキュメントを一覧表示します。 | apidog doc list --project <projectId> |
doc get | Markdown ドキュメントの詳細を表示します。 | apidog doc get <docId> --project <projectId> |
doc create | Markdown ドキュメントを作成します。 | apidog doc create --project <projectId> --file ./doc.json |
doc update | Markdown ドキュメントを更新します。 | apidog doc update <docId> --project <projectId> --file ./doc.json |
doc delete | Markdown ドキュメントを削除します。 | apidog doc delete <docId> --project <projectId> |
リソースフォルダー#
folder コマンドを使用して、さまざまなリソースタイプのフォルダーツリーを管理します。--type オプションは、endpoint、schema、test-scenario、response-component、security-scheme、test-suite、test-data などのリソースタイプを選択します。| コマンド | 説明 | 例 |
|---|
folder list | リソースタイプ別にフォルダーを一覧表示します。 | apidog folder list --project <projectId> --type endpoint |
folder create | リソースタイプ別にフォルダーを作成します。 | apidog folder create --project <projectId> --type endpoint --name "New Folder" |
folder move | フォルダーを別の親フォルダーに移動します。 | apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId> |
folder update | フォルダー名、説明、または親を更新します。 | apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name" |
folder delete | フォルダーを削除します。 | apidog folder delete <folderId> --project <projectId> --type endpoint |
cli-schema get folder-create | フォルダー作成用のスキーマを表示します。 | apidog cli-schema get folder-create |
cli-schema get folder-update | フォルダー更新用のスキーマを表示します。 | apidog cli-schema get folder-update |
--type はリソースフォルダータイプを選択します。フォルダー名ではありません。description フィールドは endpoint および test-scenario フォルダーでのみサポートされます。他のフォルダータイプでは、名前と親の更新のみがサポートされます。
モックルール#
| コマンド | 説明 | 例 |
|---|
mock list | プロジェクト内またはエンドポイント配下のモックルールを一覧表示します。 | apidog mock list --project <projectId> --http-api-id <endpointId> |
mock get | モックルールを表示します。 | apidog mock get <mockId> --project <projectId> |
mock create | JSON ファイルからモックルールを作成します。 | apidog mock create --project <projectId> --file ./mock.json |
mock update | モックルールを更新します。 | apidog mock update <mockId> --project <projectId> --file ./mock.json |
mock delete | モックルールを削除します。 | apidog mock delete <mockId> --project <projectId> |
cli-schema get mock-create | モックルール作成用のスキーマを表示します。 | apidog cli-schema get mock-create |
cli-schema get mock-update | モックルール更新用のスキーマを表示します。 | apidog cli-schema get mock-update |
共通パラメータ#
| コマンド | 説明 | 例 |
|---|
common-parameter list | 再利用可能な共通パラメータを一覧表示します。 | apidog common-parameter list --project <projectId> |
common-parameter get | 共通パラメータの詳細を表示します。 | apidog common-parameter get <commonParameterId> --project <projectId> |
common-parameter create | JSON ファイルから共通パラメータを作成します。 | apidog common-parameter create --project <projectId> --file ./common-parameter.json |
common-parameter update | 共通パラメータを更新します。 | apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json |
common-parameter import | ファイルから共通パラメータをインポートします。 | apidog common-parameter import --project <projectId> --file ./common-parameters.json |
common-parameter export | 共通パラメータをローカルファイルにエクスポートします。 | apidog common-parameter export --project <projectId> --output ./common-parameters.json |
レスポンスコンポーネント#
| コマンド | 説明 | 例 |
|---|
response-component list | 再利用可能なレスポンスコンポーネントを一覧表示します。 | apidog response-component list --project <projectId> |
response-component get | レスポンスコンポーネントの詳細を表示します。 | apidog response-component get <responseComponentId> --project <projectId> |
response-component create | JSON ファイルからレスポンスコンポーネントを作成します。 | apidog response-component create --project <projectId> --file ./response-component.json |
response-component update | レスポンス コンポーネントを更新します。 | apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json |
response-component delete | レスポンスコンポーネントを削除します。 | apidog response-component delete <responseComponentId> --project <projectId> |
セキュリティスキーム#
| コマンド | 説明 | 例 |
|---|
security-scheme list | プロジェクト内のセキュリティスキームを一覧表示します。 | apidog security-scheme list --project <projectId> |
security-scheme get | セキュリティスキームの詳細を表示します。 | apidog security-scheme get <schemeId> --project <projectId> |
security-scheme create | JSON ファイルからセキュリティスキームを作成します。 | apidog security-scheme create --project <projectId> --file ./scheme.json |
security-scheme update | セキュリティスキームを更新します。 | apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json |
security-scheme delete | セキュリティスキームを削除します。 | apidog security-scheme delete <schemeId> --project <projectId> |
API パスは API リソースパスであり、ローカルファイルパスではありません。シェルが / で始まる値を書き換える場合は、たとえば --path '/api/users' のようにパスを引用符で囲むか、--file を使用してエンドポイントデータを指定してください。API テストケースまたはテストシナリオの HTTP ステップでは、responseId にはレスポンスコンポーネント ID ではなく、endpoint.responses[].id のエンドポイントレスポンス定義 ID を使用する必要があります。レスポンスコンポーネントを再利用するには、まずエンドポイントレスポンス定義にリンクしてください。
自動テスト#
これらのコマンドを使用して、API テストケース、テストシナリオ、テストスイート、テストデータ、テストレポート、ランナー、スケジュールタスクを管理します。API テストケース#
| コマンド | 説明 | 例 |
|---|
test-case list | API テストケースを一覧表示します。必要に応じてエンドポイントで絞り込めます。 | apidog test-case list --project <projectId> --endpoint <endpointId> |
test-case category | テストケースカテゴリを一覧表示します。 | apidog test-case category --project <projectId> |
test-case get | API テストケースの詳細を表示します。 | apidog test-case get <caseId> --project <projectId> |
test-case create | JSON ファイルから API テストケースを作成します。 | apidog test-case create --project <projectId> --file ./case.json |
test-case update | API テストケースを更新します。 | apidog test-case update <caseId> --project <projectId> --file ./case.json |
test-case delete | API テストケースを削除します。 | apidog test-case delete <caseId> --project <projectId> |
cli-schema get test-case-create | テストケース作成用のスキーマを表示します。 | apidog cli-schema get test-case-create |
cli-schema get test-case-update | テストケース更新用のスキーマを表示します。 | apidog cli-schema get test-case-update |
テストシナリオ#
| コマンド | 説明 | 例 |
|---|
test-scenario list | プロジェクト内のテストシナリオを一覧表示します。 | apidog test-scenario list --project <projectId> |
test-scenario get | テストシナリオの詳細を表示します。 | apidog test-scenario get <scenarioId> --project <projectId> |
test-scenario create | テストシ ナリオを作成します。 | apidog test-scenario create --project <projectId> --file ./scenario.json |
test-scenario update | テストシナリオを更新します。 | apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json |
test-scenario delete | テストシナリオを削除します。 | apidog test-scenario delete <scenarioId> --project <projectId> |
test-scenario run | テストシナリオを実行します。 | apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId> |
cli-schema get test-scenario-create | テストシナリオ作成用のスキーマを表示します。 | apidog cli-schema get test-scenario-create |
cli-schema get test-scenario-update | テストシナリオ更新用のスキーマを表示します。 | apidog cli-schema get test-scenario-update |
テストスイート#
| コマンド | 説明 | 例 |
|---|
test-suite list | プロジェクト内のテストスイートを一覧表示します。 | apidog test-suite list --project <projectId> |
test-suite get | テストスイートの詳細を表示します。 | apidog test-suite get <testSuiteId> --project <projectId> |
test-suite create | テストスイートを作成します。 | apidog test-suite create --project <projectId> --file ./suite.json |
test-suite update | テストスイートを更新します。 | apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json |
test-suite delete | テストスイートを削除します。 | apidog test-suite delete <testSuiteId> --project <projectId> |
test-suite run | テストスイートを実行します。 | apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId> |
テストデータ#
| コマンド | 説明 | 例 |
|---|
test-data list | テストデータセットを一覧表示します。 | apidog test-data list --project <projectId> |
test-data get | テストデータセットの詳細を表示します。 | apidog test-data get <dataId> --project <projectId> |
test-data create | JSON ファイルからテストデータセットを作成します。 | apidog test-data create --project <projectId> --file ./test-data.json |
test-data update | テストデータセットを更新します。 | apidog test-data update <dataId> --project <projectId> --file ./test-data.json |
test-data delete | テストデータセットを削除します。 | apidog test-data delete <dataId> --project <projectId> |
テストレポート#
| コマンド | 説明 | 例 |
|---|
test-report list | プロジェクト内のテストレポートを一覧表示します。 | apidog test-report list --project <projectId> |
test-report get | テストレポートの詳細を表示します。 | apidog test-report get <reportId> --project <projectId> |
test-report download | テストレポートをローカルファイルにダウンロードします。 | apidog test-report download <reportId> --project <projectId> --format json --output ./report.json |
test-report delete | テストレポートを削除します。 | apidog test-report delete <reportId> --project <projectId> |
ラン ナー#
| コマンド | 説明 | 例 |
|---|
runner list | プロジェクトまたはチーム内のランナーを一覧表示します。 | apidog runner list --project <projectId> |
runner get | ランナーの詳細を表示します。 | apidog runner get <runnerId> --project <projectId> |
runner create | チームランナーを作成します。 | apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType> |
runner check | ランナーのヘルス状態を確認します。 | apidog runner check <runnerId> --team <teamId> |
runner delete | ランナーを削除します。 | apidog runner delete <runnerId> --project <projectId> |
スケジュールタスク#
| コマンド | 説明 | 例 |
|---|
scheduled-task list | プロジェクト内のスケジュールタスクを一覧表示します。 | apidog scheduled-task list --project <projectId> |
scheduled-task get | スケジュールタスクの詳細を表示します。 | apidog scheduled-task get <taskId> --project <projectId> |
scheduled-task create | JSON ファイルからスケジュールタスクを作成します。 | apidog scheduled-task create --project <projectId> --file ./scheduled-task.json |
scheduled-task update | スケジュールタスクを更新します。 | apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json |
scheduled-task delete | スケジュールタスクを削除します。 | apidog scheduled-task delete <taskId> --project <projectId> |
scheduled-task run | スケジュールタスクを手動でトリガーします。 | apidog scheduled-task run <taskId> --project <projectId> |
コア実行コマンド: apidog run#
これは、テストシナリオ、テストシナリオフォルダー、テストスイート、またはローカルにエクスポートされたファイルを実行するための主要なコマンドです。Apidog クライアントの CI/CD パネルから生成されたコマンドをコピーし、ターミナルまたは CI/CD ワークフローで実行できます。オンライン実行#
Apidog サーバー経由でリアルタイムテストを実行する場合は、次のコマンドを使用します。Apidog アクセストークンを、特定のテストシナリオ、テストシナリオディレクトリ、またはテストスイートの ID とともに使用します。例:ローカル実行#
エクスポート済みファイルを使用してオフラインテストを実行する場合は、次のコマンドを使用します。Apidog テストシナリオの URL またはファイルパスを指定します。例:実行オプション#
| オプション | 説明 |
|---|
--access-token <accessToken> | オンライン実行用の認証トークンを設定します |
-t, --test-scenario <testScenarioId> | 実行するテストシナリオ ID を指定します |
-f, --test-scenario-folder <folderId> | 実行するテストシナリオディレクトリ ID を指定します |
--test-suite <testSuiteId> | 実行するテストスイート ID を指定します |
--project <projectId> | プロジェクト ID を指定します |
--branch <branchName> | ブランチ名を指定します。省略した場合、サーバーはデフォルトでメインブランチを使用します |
-r, --reporters [reporters] | テストレポートタイプを指定します（デフォルト: ["cli"]） |
--out-dir <outDir> | テストレポートの出力ディレクトリを指定します（デフォルト: ./apidog-reports） |
--out-file <outFile> | テストレポートの出力ファイル名を指定します。ファイル拡張子を追加する必要はありません。{FOLDER_NAME}、{SCENARIO_NAME}、{GENERATE_TIME} を使用できます |
--out-json-failures-separated <outJsonFailuresSeparated> | 失敗を個別の JSON ファイルとしてエクスポートします |
-e, --environment <environmentId> | 実行時環境を指定します |
-n, --iteration-count <n> | イテレーション回数を設定します |
-d, --iteration-data <path> | ケースイテレーション用のデータを設定します（JSON または CSV） |
--on-error <behavior> | エラー処理動作を設定します（ignore、continue、または end） |
--variables <path> | ローカルファイルから環境変数またはグローバル変数を読み込みます |
--global-var <value> | グローバル変数を設定します（key=value 形式） |
--env-var <value> | 環境変数を設定します（key=value 形式） |
--notification <ids> | 実行完了後に通知を送信します |
--notification-failed-event <ids> | 実行が失敗した場合にのみ通知を送信します |
--external-program-path <path> | 外部プログラムのファイルパスを指定します |
--database-connection <path> | データベース設定のファイルパスを指定します |
--ignore-redirects | 自動リダイレクトを防止します |
--silent | コンソール出力を防止します |
--color <value> | カラー付きコンソール出力を有効化または無効化します |
--delay-request [n] | リクエスト間の遅延を指定します（ms） |
--timeout-request [n] | リクエストタイムアウトを指定します（ms） |
--timeout-script [n] | スクリプト実行タイムアウトを指定します（ms） |
-k, --insecure | SSL 検証を無効化します |
--ssl-client-cert-list <path> | クライアント証明書設定パスを指定します |
--ssl-client-cert <path> | クライアント証明書パス（PEM）を指定します |
--ssl-client-key <path> | クライアント証明書の秘密鍵パスを指定します |
--ssl-client-passphrase <passphrase> | クライアント証明書のパスフレーズを指定します |
--ssl-extra-ca-certs <path> | 追加の信頼済み CA 証明書を指定します |
-b, --bigint | bigint 互換性を有効化します |
--upload-report [value] | テストレポート概要をクラウドにアップロードします |
--preferred-http-version <preferredHttpVersion> | 優先 HTTP プロトコルバージョンを設定します |
--verbose | 詳細なリクエストおよびレスポンス情報を表示します |
--lang <language> | CLI 言 語を設定します（en） |
-h, --help | ヘルプ情報を表示します |
テストシナリオ、テストスイート、テストケース、テストデータ、スケジュールタスクなどの複雑なテストリソースを作成または更新する場合は、まず cli-schema get <schemaKey> を使用し、その後 cli-schema validate <schemaKey> --file <path> でローカルファイルを検証してください。
インポートとエクスポート#
インポートおよびエクスポートコマンドを使用して、外部 API ドキュメントを Apidog に取り込んだり、プロジェクトデータを他のツールで使用される形式にエクスポートしたりします。プロジェクトデータのインポート#
import コマンドは、ローカルファイルをプロジェクトにインポートします。サポートされる形式には、openapi、postman、har、insomnia、jmeter、wsdl、yapi、rap2、apidoc、hoppscotch、markdown、jsonschema、apidog が含まれます。| コマンド | 説明 | 例 |
|---|
import | 形式を指定してローカルファイルをプロジェクトにインポートします。 | apidog import --project <projectId> --format openapi --file ./openapi.json |
自動インポート設定#
import auto-import を使用して、外部ソースからの長期同期用の自動インポート設定を管理します。| コマンド | 説明 | 例 |
|---|
import auto-import list | プロジェクト内の自動インポート設定を一覧表示します。 | apidog import auto-import list --project <projectId> |
import auto-import create | 自動インポート設定を作成します。 | apidog import auto-import create --project <projectId> --file ./auto-import.json |
import auto-import get | 自動インポート設定を表示します。 | apidog import auto-import get <settingId> --project <projectId> |
import auto-import delete | 自動インポート設定を削除します。 | apidog import auto-import delete <settingId> --project <projectId> |
cli-schema get import-auto-import-create | 自動インポート設定用のスキーマを表示します 。 | apidog cli-schema get import-auto-import-create |
プロジェクトデータのエクスポート#
export コマンドは、プロジェクトデータをローカルファイルにエクスポートします。サポートされる形式には、openapi、markdown、html、postman、apidog が含まれます。ネイティブ apidog エクスポートでは、スコープとして all、apis、tags がサポートされます。フォルダースコープは OpenAPI エクスポートでのみ利用できます。| コマンド | 説明 | 例 |
|---|
export | 形式を指定してプロジェクトデータをエクスポートします。 | apidog export --project <projectId> --format openapi --output ./openapi.json |
export --format apidog | ネイティブプロジェクトデータをエクスポートします。 | apidog export --project <projectId> --format apidog --output ./project.apidog.json |
export --scope apis | ネイティブ形式で選択した API をエクスポートします。 | apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json |
export --scope tags | ネイティブ形式でタグ別に API をエクスポートします。 | apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json |
export --format openapi --scope folders | OpenAPI 形式で選択したフォルダーをエクスポートしま す。 | apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json |
OAS エクスポート設定#
export settings を使用して、再利用可能な OAS エクスポート設定を管理します。| コマンド | 説明 | 例 |
|---|
export settings list | OAS エクスポート設定を一覧表示します。 | apidog export settings list --project <projectId> |
export settings create | OAS エクスポート設定を作成します。 | apidog export settings create --project <projectId> --file ./export-setting.json |
export settings get | OAS エクスポート設定を表示します 。 | apidog export settings get <settingId> --project <projectId> |
export settings update | OAS エクスポート設定を更新します。 | apidog export settings update <settingId> --project <projectId> --file ./export-setting.json |
export settings delete | OAS エクスポート設定を削除します。 | apidog export settings delete <settingId> --project <projectId> |
cli-schema get export-settings-create | OAS エクスポート設定作成用のスキーマを表示します。 | apidog cli-schema get export-settings-create |
cli-schema get export-settings-update | OAS エクスポート設定更新用のスキーマを表示します。 | apidog cli-schema get export-settings-update |
ドキュメント共有#
これらのコマンドを使用して、API ドキュメントを公開および共有します。ドキュメントサイト#
| コマンド | 説明 | 例 |
|---|
docs-site list | ドキュメントサイトを一覧表示します。 | apidog docs-site list --project <projectId> |
docs-site get | ドキュメントサイトの詳細を表示します。 | apidog docs-site get <siteId> --project <projectId> |
docs-site create | ドキュメントサイトを作成します。 | apidog docs-site create --project <projectId> --file ./docs-site.json |
docs-site update | ドキュメントサイト設定を更新します。 | apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json |
docs-site delete | ドキュメントサイトを削除します。 | apidog docs-site delete <siteId> --project <projectId> |
共有ドキュメント#
| コマンド | 説明 | 例 |
|---|
shared-doc list | 共有ドキュメントを一覧表示します。 | apidog shared-doc list --project <projectId> |
shared-doc get | 共有ドキュメントの詳細を表示します。 | apidog shared-doc get <docId> --project <projectId> |
shared-doc create | 共有ドキュメントを作成します。 | apidog shared-doc create --project <projectId> --file ./shared-doc.json |
shared-doc update | 共有ドキュメント設定を更新します。 | apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json |
shared-doc delete | 共有ドキュメントを削除します。 | apidog shared-doc delete <docId> --project <projectId> |
ブランチ管理#
ブランチコマンドを使用して、変更を分離し、プロジェクトリソースで共同作業し、ブランチ間で選択したリソースをマージします。イテレーションブランチ#
| コマンド | 説明 | 例 |
|---|
branch list --type all | プロジェクト内のすべてのブランチタイプを一覧表示します。 | apidog branch list --project <projectId> --type all |
branch list --type sprint | イテレーションブランチを一覧表示します。 | apidog branch list --project <projectId> --type sprint |
branch get --type sprint | イテレーションブランチを表示します。 | apidog branch get <branchName> --project <projectId> --type sprint |
branch create --type sprint | イテレーションブランチを作成します。 | apidog branch create --project <projectId> --type sprint --name <branchName> --from main |
branch update --type sprint | イテレーションブランチを更新します。 | apidog branch update <branchName> --project <projectId> --type sprint --name <newName> |
branch merge | 1 つのブランチから別のブランチへ、明示的に選択したリソースをマージします。 | apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids> |
branch pick-to | ソースブランチからターゲットブランチへ、選択したリソースを取り込みます。 | apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids> |
branch archive --type sprint | 削除前にイテレーションブランチをアーカイブします。 | apidog branch archive <branchName> --project <projectId> --type sprint |
branch delete --type sprint | アーカイブ済みのイテレーションブランチを削除します。 | apidog branch delete <branchName> --project <projectId> --type sprint |
AI ブランチ#
| コマンド | 説明 | 例 |
|---|
branch list --type ai | AI ブランチを一覧表示します。 | apidog branch list --project <projectId> --type ai |
branch get --type ai | AI ブランチを表示します。 | apidog branch get <branchName> --project <projectId> --type ai |
branch create --type ai | ソースブランチから AI ブランチを作成します。 | apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName> |
branch update --type ai | AI ブランチを更新します。 | apidog branch update <branchName> --project <projectId> --type ai --name <newName> |
branch archive --type ai | 削除前に AI ブランチをアーカイブします。 | apidog branch archive <branchName> --project <projectId> --type ai |
branch delete --type ai | アーカイブ済みの AI ブランチを削除します。 | apidog branch delete <branchName> --project <projectId> --type ai |
一般ブランチ#
| コマンド | 説明 | 例 |
|---|
branch list --type general | 一般ブランチを一覧表示します。 | apidog branch list --project <projectId> --type general |
branch get --type general | 一般ブランチを表示します。 | apidog branch get <branchName> --project <projectId> --type general |
branch create --type general | 一般ブランチを作成します。 | apidog branch create --project <projectId> --type general --name <branchName> --from main |
branch update --type general | 一般ブランチを更新します。 | apidog branch update <branchName> --project <projectId> --type general --name <newName> |
branch delete --type general | 一般ブランチを削除します。 | apidog branch delete <branchName> --project <projectId> --type general |
ブランチ作成コマンドでは主に、--type、--name、--from などのコマンドラインオプションを使用します。cli-schema get branch-*-create は、作成オプション構造を確認するために使用します。実際のコマンドオプションについては、apidog branch create -h を実行してください。
マージリクエスト#
ターゲットブランチでレビューフローが必要な場合は、merge-request を使用します。マージリクエストと直接マージでは、明示的に選択されたリソースのみがマージされます。| コマンド | 説明 | 例 |
|---|
merge-request preview | マージリクエストまたは直接マージを作成する前に、候補の変更をスキャンします。 | apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName> |
merge-request list | マージリクエストを一覧表示します。 | apidog merge-request list --project <projectId> --to <targetBranchName> |
merge-request get | マージリクエストの詳細を表示します。 | apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName> |
merge-request create | マージリクエストを作成します。 | apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids> |
merge-request update | マージリクエストを更新します。 | apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json |
merge-request approve | マージリクエストを承認します。 | apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json |
merge-request reject | マージリクエストを却下します。 | apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName> |
merge-request delete | マージリクエストを削除します。 | apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName> |
プロジェクトリソースの安全性を保つため、CLI の書き込み権限はデフォルトで制限されている場合があります。AI ブランチを通じてソースブランチデータを編集するか、メインブランチ、標準イテレーションブランチ、または一般ブランチで直接編集が必要な場合は、プロジェクト機能設定で外部編集権限を有効化できます。AI ブランチで行われた変更も、merge または merge-request の前にユーザー確認が必要です。AI ブランチ名には、日付、ソースブランチ、目的を含めることをお勧めします。例: ai/20260312-from-main-user-register。
ブランチのマージおよび取り込み操作では、リソース ID オプションは複数形の名前とカンマ区切りの数値 ID を使用します。例: --endpoint-ids 1,2、--doc-ids 3,4、--test-suite-ids 5,6。
その他のリソース#
これらのコマンドを使用して、プロジェクト拡張リソースおよび外部接続を管理します。カスタムフィールド#
| コマンド | 説明 | 例 |
|---|
custom-field list | カスタムフィールドを一覧表示します。 | apidog custom-field list --project <projectId> |
custom-field create | カスタムフィールドを作成します。 | apidog custom-field create --project <projectId> --file ./custom-field.json |
custom-field update | カスタムフィールドを更新します。 | apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json |
custom-field delete | カスタムフィールドを削除します。 | apidog custom-field delete <customFieldId> --project <projectId> |
WebSocket API#
| コマンド | 説明 | 例 |
|---|
websocket list | WebSocket API を一覧表示します。 | apidog websocket list --project <projectId> |
websocket get | WebSocket API の詳細を表示します。 | apidog websocket get <websocketId> --project <projectId> |
websocket create | WebSocket API を作成します。 | apidog websocket create --project <projectId> --name <name> --url <url> |
websocket update | WebSocket API を更新します。 | apidog websocket update <websocketId> --project <projectId> --file ./websocket.json |
websocket delete | WebSocket API を削除します。 | apidog websocket delete <websocketId> --project <projectId> |
Socket.IO API#
| コマンド | 説明 | 例 |
|---|
socketio list | Socket.IO API を一覧表示します。 | apidog socketio list --project <projectId> |
socketio get | Socket.IO API の詳細を表示します。 | apidog socketio get <socketioId> --project <projectId> |
socketio create | Socket.IO API を作成します。 | apidog socketio create --project <projectId> --file ./socketio.json |
socketio update | Socket.IO API を更新します。 | apidog socketio update <socketioId> --project <projectId> --file ./socketio.json |
socketio delete | Socket.IO API を削除します。 | apidog socketio delete <socketioId> --project <projectId> |
共通スクリプト#
| コマンド | 説明 | 例 |
|---|
common-script list | 共通スクリプトを一覧表示します。 | apidog common-script list --project <projectId> |
common-script get | 共通スクリプトの詳細を表示します。 | apidog common-script get <scriptId> --project <projectId> |
common-script create | 共通スクリプトを作成します。 | apidog common-script create --project <projectId> --file ./common-script.json |
common-script update | 共通スクリプトを更新します。 | apidog common-script update <scriptId> --project <projectId> --file ./common-script.json |
common-script delete | 共通スクリプトを削除します。 | apidog common-script delete <scriptId> --project <projectId> |
データベース接 続#
| コマンド | 説明 | 例 |
|---|
database-connection list | データベース接続を一覧表示します。 | apidog database-connection list --project <projectId> |
database-connection get | データベース接続の詳細を表示します。 | apidog database-connection get <connectionId> --project <projectId> |
database-connection create | データベース接続を作成します。 | apidog database-connection create --project <projectId> --file ./database-connection.json |
database-connection update | データベース接続を更新します。 | apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json |
database-connection delete | データベース接続を削除します。 | apidog database-connection delete <connectionId> --project <projectId> |
Vault プロバイダー#
| コマンド | 説明 | 例 |
|---|
vault list | Vault プロバイダーを一覧表示します。 | apidog vault list --project <projectId> |
vault get | Vault プロバイダーの詳細を表示します。 | apidog vault get <vaultProviderId> --project <projectId> |
vault create | Vault プロバイダーを作成します。 | apidog vault create --project <projectId> --file ./vault.json |
vault update | Vault プロバイダーを更新します。 | apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json |
vault delete | Vault プロバイダーを削除します。 | apidog vault delete <vaultProviderId> --project <projectId> |
Git 接続#
| コマンド | 説明 | 例 |
|---|
git-connection list | Git 接続を一覧表示します。 | apidog git-connection list --project <projectId> |
git-connection get | Git 接続の詳細を表示します。 | apidog git-connection get <connectionId> --project <projectId> |
git-connection create | Git 接続を作成します。 | apidog git-connection create --project <projectId> --file ./git-connection.json |
git-connection update | Git 接続を更新します。 | apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json |
git-connection delete | Git 接続を削除します。 | apidog git-connection delete <connectionId> --project <projectId> |
管理と設定#
これらのコマンドを、プロジェクト管理、通知、ごみ箱リソース、変更履歴、監査ログに使用します。| コマンド | 説明 | 例 |
|---|
notification list | 通知設定を一覧表示します。 | apidog notification list --project <projectId> |
notification get | 通知の詳細を表示します。 | apidog notification get <notificationId> --project <projectId> |
notification create | 通知設定を作成します。 | apidog notification create --project <projectId> --file ./notification.json |
notification update | 通知設定を更新します。 | apidog notification update <notificationId> --project <projectId> --file ./notification.json |
notification delete | 通知設定を削除します。 | apidog notification delete <notificationId> --project <projectId> |
ごみ箱#
| コマンド | 説明 | 例 |
|---|
recycle list | ごみ箱内のリソースを一覧表示します。 | apidog recycle list --project <projectId> |
recycle restore | ごみ箱からリソースを復元します。 | apidog recycle restore <itemId> --project <projectId> |
recycle delete | ごみ箱のリソースを完全に削除します。 | apidog recycle delete <itemId> --project <projectId> |
| コマンド | 説明 | 例 |
|---|
history list | プロジェクトの変更履歴を一覧表示します。 | apidog history list --project <projectId> |
history get | 変更履歴の詳細を表示します。 | apidog history get <historyId> --project <projectId> |
監査ログ#
| コマンド | 説明 | 例 |
|---|
audit-log list | プロジェクト監査ログを一覧表示します。 | apidog audit-log list --project <projectId> |
audit-log get | 監査ログの詳細を表示します。 | apidog audit-log get <auditLogId> --project <projectId> |
高度な使用方法#
CLI でのファイルアップロード#
ファイルアップロードが必要な API を扱う場合、アップロードするファイルのパスを正確に設定することが重要です。テストを実行する同じマシンにファイルを保存し、絶対パスまたは相対パスのいずれかで参照する必要があります。アップロードするファイルを参照するには、次の手順に従ってください。1
必要なファイルを、CLI を実行するマシンに事前にコピーします。たとえば、CI/CD パイプラインとして GitHub Actions を使用している場合は、必要なファイルをワークフローと同じ GitHub リポジトリにコピーします。
2
Apidog でテストシナリオに移動し、ファイルアップロードが必要なステップを見つけます。以下に示すように、
Bulk Edit ボタンをクリックします。
3
CLI マシンにコピーしたファイルのパスをコピーします。その後、ファイルフィールドのパラメータ値を CLI マシン上のファイルパスに置き換えます。たとえば、GitHub リポジトリの
data フォルダー配下に
png ファイルを置いた場合、
data/to-be-uploaded.png を使用して参照できます。
このテストシナリオをローカルで再度実行したい場合は、パラメータ値内のファイルパスをローカルマシン上のパスに戻す必要があります。
CLI でのデータベース操作の使用#
テストシナリオにデータベース操作が含まれる場合、データベース設定はクラウドではなくローカルに保存されるため、いくつか追加の手順が必要です。つまり、これらのシナリオではクラウドモードで CLI を直接実行することはできませ ん。この状況への対応方法は次のとおりです。1
データベース操作を含むテストシナリオでは、コマンドライン生成インターフェースに「Download the database configuration file.」というプロンプトが表示されます。
2
このファイルをダウンロードし、Apidog CLI を実行する予定のディレクトリに配置します。
3
自動生成されたコマンドラインには --database-connection オプションが含まれます。このコマンドラインをそのまま使用してテストを実行できます 。
ローカル CLI テストレポートをクラウドにアップロードする#
ローカル CLI テストレポートをクラウドにアップロードするには、CLI コマンドの末尾に --upload-report パラメータを追加できます。手順は次のとおりです。1
CLI コマンドに
--upload-report パラメータを追加します。
2
このコマンドはテストを実行し、完了後にテストレポートを自動的にクラウドへアップロードします。
3
アップロードされたレポートを表示するには、次の手順を実行します。
Apidog ダッシュボードの「テストレポート」セクションに移動します。
4
注意: CLI 経由でアップロードされたレポートでは、「テスター」フィールドは空として表示されます。
CLI での外部スクリプト/プログラムの使用#
Apidog CLI の実行時に、コマンドの末尾にパスを追加することで外部スクリプトまたはプログラムを参照できます。手順は次のとおりです。この例では、CLI に対して ./scripts ディレクトリにあるプログラムを参照するよう指示しています。階層が指定されていない場合、デフォルトは現在の CLI 実行ディレクトリです。これらの外部スクリプトを管理する主な方法は 2 つあります。1. ローカルパス#
ローカルスクリプト管理の混乱を避けるため、次のことをお勧めします。2. クラウドコードリポジトリ#
スクリプトファイルをクラウドベースのコードリポジトリでホストする
CI/CD ワークフローで pull コマンドを設定し、外部スクリプトをローカル環境に取得する
CLI コマンドで外部スクリプトの実際のパスを指定する
SSL#
クライアント証明書#
Apidog CLI はクライアント証明書の受け渡しをサポートしています。単一の SSL クライアント証明書の使用#
--ssl-client-cert
公開 SSL クライアント証明書のパスを指定します。
--ssl-client-key
秘密 SSL クライアント証明書のパスを指定します（任意）。
--ssl-client-passphrase
SSL クライアントパスフレーズを指定します（任意）。
SSL クライアント証明書設定ファイルの使用（複数証明書をサポート）#
--ssl-client-cert-list
SSL クライアント証明書リストの JSON ファイルのパスを指定します。例: ssl-client-cert-list.json
[
{
"name": "domain1",
"matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
"key": {"src": "/CI/client.domain1.key"},
"cert": {"src": "/CI/client.domain1.crt"},
"passphrase": "changeme"
},
{
"name": "domain2",
"matches": ["https://domain2.com/*"],
"key": {"src": "/CI/client.domain2.key"},
"cert": {"src": "/CI/client.domain2.crt"},
"passphrase": "changeme"
}
]
--ssl-client-cert、--ssl-client-key、--ssl-client-passphrase オプションより優先されます。リスト内の URL に一致するものがない場合、これらのオプションはフォールバックオプションとして使用されます。HTTP/2#
CLI は、--preferred-http-version パラメータを使用することで、リクエスト送信に使用する特定のプロトコルバージョンを設定できます。1.
"HTTP/2" - HTTP/2 Application-Layer Protocol Negotiation (ALPN)。HTTPS リクエストでのみサポートされます。
2.
"HTTP/2-with-prior-knowledge" - 事前知識ありの HTTP/2。
1.
HTTPS リクエストと HTTP リクエストに異なるプロトコルバージョンを設定する: 2.
HTTPS と HTTP の両方に同じプロトコルバージョンを設定する: 3.
HTTPS と HTTP の両方に HTTP/2 を設定する（サポートされていない値は自動的に無視されます）: FAQ#
このエラーは通常、Authorization ヘッダー内の無効な文字（非 ASCII 文字、改行、余分なスペースなど）が原因で発生します。Apidog クライアントまたは Web インターフェースでテストシナリオを実行してもエラーが発生しないことが確実な場合は、環境内の変数に INITIAL 値を設定しているかどうかを確認し、Authorization 値が想定される形式と一致していることを確認してください。
安全のため、プロジェクトの書き込み権限が制限されている場合があります。プロジェクトの機能設定を確認し、直接編集が必要な場合は外部編集 権限を有効化してください。
