--project <projectId>를 사용하여 프로젝트를 지정합니다. --branch <branchName>을 사용하여 특정 브랜치에서 작업할 수 있습니다. --branch가 생략되면 서버는 기본 브랜치를 사용합니다.| 명령 | 설명 | 예시 |
|---|---|---|
login | 액세스 토큰으로 로그인하고 로컬에 저장합니다. | apidog login --with-token <token> |
logout | 로그아웃하고 저장된 로컬 토큰을 지웁니다. | apidog logout |
whoami | 현재 인증된 사용자 정보를 표시합니다. | apidog whoami |
${{ vars.APIDOG_ACCESS_TOKEN }}를 사용하여 참조하십시오.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와 같이 명령 경로와 작업을 조합합니다.| 명령 | 설명 | 예시 |
|---|---|---|
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 |
| 명령 | 설명 | 예시 |
|---|---|---|
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 |
cli-schema get <schemaKey> 및 cli-schema validate <schemaKey> --file <path>를 실행하는 것이 좋습니다.| 명령 | 설명 | 예시 |
|---|---|---|
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 |
| 명령 | 설명 | 예시 |
|---|---|---|
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> |
/로 시작하는 값을 다시 쓰는 경우, 예를 들어 --path '/api/users'처럼 경로를 따옴표로 감싸거나 --file을 사용하여 엔드포인트 데이터를 제공하십시오.responseId는 응답 컴포넌트 ID가 아니라 endpoint.responses[].id의 엔드포인트 응답 정의 ID를 사용해야 합니다. 응답 컴포넌트를 재사용하려면 먼저 엔드포인트 응답 정의에서 연결하십시오.| 명령 | 설명 | 예시 |
|---|---|---|
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| 옵션 | 설명 |
|---|---|
--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>로 로컬 파일을 검증하십시오.