Apidog Docs
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. Apidog CLI
  • Apidog 학습 센터
  • 시작하기
    • Apidog 소개
    • Apidog의 기본 개념
    • Apidog 탐색하기
    • 빠른 시작
      • 개요
      • 엔드포인트 생성하기
      • 요청 만들기
      • 어서션 추가하기
      • 테스트 시나리오 생성
      • API 문서 공유
      • 더 알아보기
    • Apidog로 마이그레이션
      • 개요
      • 수동 가져오기
      • 예약 가져오기(데이터 소스 바인딩)
      • 가져오기 옵션
      • 데이터 내보내기
      • 가져오기
        • Postman에서 가져오기
        • OpenAPI Spec 가져오기
        • cURL 가져오기
        • Markdown 가져오기
        • Insomnia에서 가져오기
        • apiDoc에서 가져오기
        • .har 파일 가져오기
        • WSDL 가져오기
  • Mock API 데이터
    • 개요
    • 스마트 목
    • 사용자 지정 목
    • 목 우선순위 순서
    • 목 스크립트
    • 클라우드 목
    • Self-Hosted Runner Mock
    • 목 언어(로케일)
  • 계정 및 환경설정
    • 계정 설정
    • OpenAPI 액세스 토큰 생성
    • 알림
    • 언어 설정
    • 단축키
    • 네트워크 프록시 구성
    • 데이터 백업
    • Apidog 업데이트
    • 계정 삭제
    • 실험적 기능
  • 요청 보내기
    • 개요
    • SSE 디버깅
    • MCP 클라이언트
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 또는 WebService
    • GraphQL
    • gRPC
    • 디버깅에 요청 프록시 에이전트 사용
    • 요청 만들기
      • 요청 기록
      • 요청 기본 사항
      • 매개변수 및 본문
      • 요청 헤더
      • 요청 설정
      • 요청 디버그
      • 요청을 엔드포인트로 저장하기
      • HTTP/2
    • 인증 및 권한 부여
      • 개요
      • CA 및 클라이언트 인증서
      • 인증 유형
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 인증
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 응답 및 쿠키
      • API 응답 보기
      • 쿠키 관리
      • 개요
  • API 개발 및 디버깅
    • 개요
    • 요청 생성
    • 요청 보내기
    • 디버깅 케이스
    • 테스트 케이스
    • 동적 값
    • 응답 검증
    • 디자인 우선 vs 요청 우선
    • 코드 생성
    • 환경 및 변수
      • 개요
      • 변수 사용하기
      • 환경 관리
    • Vault 시크릿
      • 개요
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 동적 값 모듈
      • Airline
      • 동물
      • 색상
      • Commerce
      • Company
      • 데이터베이스
      • Datatype
      • 날짜
      • 금융
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • 음악
      • Number
      • Person
      • Phone
      • 과학
      • String
      • System
      • Vehicle
      • Word
    • 사전/사후 프로세서
      • 개요
      • 어서션
      • 변수 추출
      • Wait
      • 보안
      • 데이터베이스 작업
        • 개요
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 스크립트 사용
        • 개요
        • 전처리 스크립트
        • 사후 처리 스크립트
        • Public Scripts
        • Postman 스크립트 참조
        • 다른 프로그래밍 언어 호출하기
        • JS 라이브러리 사용하기
        • 응답 시각화
        • 스크립트 예제
          • 어서션 스크립트
          • 변수 사용하기
          • 요청 수정하기
          • 기타 예시
    • API 디버깅
      • AI Agent Debugger
      • A2A Debugger
  • API 설계
    • 개요
    • 새 API 프로젝트 생성
    • 엔드포인트 기본 사항
    • API 설계 지침
    • 모듈
    • 여러 요청 본문 예시 구성
    • 컴포넌트
    • 공통 필드
    • 전역 매개변수
    • 엔드포인트 변경 이력
    • 댓글
    • 엔드포인트 일괄 관리
    • 사용자 지정 프로토콜 API
    • Spec-first 모드(Beta)
    • 보안 스키마
      • 개요
      • 보안 스키마 생성
      • 보안 스키마 사용
      • 온라인 문서의 보안 스키마
    • 고급 기능
      • 사용자 지정 엔드포인트 필드
      • 연결된 테스트 시나리오
      • 엔드포인트 상태
      • 매개변수 목록의 표시 방식
      • 엔드포인트 고유 식별
    • 스키마
      • 개요
      • 새 스키마 생성
      • 스키마 구축
      • JSON 등에서 스키마 생성
      • oneOf, allOf, anyOf
      • Discriminator 사용하기
  • API 테스트
    • 개요
    • 테스트 시나리오
      • 테스트 시나리오 생성
      • 요청 간 데이터 전달
      • 흐름 제어 조건
      • 엔드포인트 및 엔드포인트 케이스에서 데이터 동기화
      • 다른 프로젝트에서 엔드포인트 및 엔드포인트 케이스 가져오기
      • 테스트 시나리오 내보내기
    • 테스트 보고서
      • 테스트 보고서
    • 테스트 시나리오 실행
      • 테스트 시나리오 실행
      • 테스트 시나리오 일괄 실행
      • 데이터 기반 테스트
      • 공유 테스트 데이터
      • 예약 작업
      • 다른 프로젝트의 API 런타임 환경 관리
    • 테스트 스위트
      • 개요
      • 테스트 스위트 생성
      • 테스트 스위트 오케스트레이션
      • 로컬에서 테스트 스위트 실행
      • CLI를 통해 테스트 스위트 실행
      • 예약 작업
    • API 테스트
      • 통합 테스트
      • 성능 테스트
      • 엔드투엔드 테스트
      • 회귀 테스트
      • 계약 테스트
    • Apidog CLI
      • 개요
      • Apidog CLI 설치 및 실행
      • Apidog CLI 옵션
    • CI/CD
      • 개요
      • Github Actions와 통합
      • Gitlab과 통합
      • Jenkins와 통합하기
      • Git 커밋으로 테스트 트리거하기
  • API 문서 게시
    • 개요
    • 지원되는 API 기술
    • Quick Share
    • API 문서 보기
    • Markdown 문서
    • 문서 사이트 게시
    • 사용자 지정 로그인 페이지
    • 사용자 지정 레이아웃
    • 사용자 지정 CSS, JavaScript, HTML
    • 사용자 지정 도메인
    • AI 기능
    • SEO 설정
    • 고급 설정
      • 문서 검색
      • CORS 프록시
      • Google Analytics 통합
      • 폴더 트리 설정
      • 가시성 설정
      • 문서 URL에 값 임베드하기
    • API 버전
      • 개요
      • API 버전 생성
      • API 버전 게시
      • API 버전별 엔드포인트 공유
  • 브랜치
    • 개요
    • 스프린트 브랜치 생성
    • 브랜치에서 API 테스트하기
    • 브랜치에서 API 설계하기
    • 스프린트 브랜치 병합
    • 스프린트 브랜치 관리
    • AI Branch(베타)
  • AI 기능
    • 개요
    • AI 기능 활성화
    • 테스트 케이스 생성
    • AI로 스키마 수정하기
    • 엔드포인트 규정 준수 검사
    • API 문서 완성도 검사
    • AI 기반 필드 명명
    • 자주 묻는 질문
  • Apidog MCP 서버
    • 개요
    • AI에 Apidog 프로젝트 연결
    • 게시된 문서를 AI에 연결하기
    • OpenAPI 파일을 AI에 연결하기
  • 모범 사례
    • API 서명 처리
    • OAuth 2.0으로 보호되는 API에 접근하기
    • 협업 워크플로
    • 인증 상태 관리
  • 오프라인 공간
    • 개요
  • Apidog Europe
    • Apidog Europe
  • 관리
    • 프로젝트 관리
      • 프로젝트 관리
      • 알림 설정
      • 프로젝트 멤버 관리
      • 프로젝트 리소스
        • 데이터베이스 연결
        • Git 연결
    • 팀 관리
      • 팀 관리
      • 팀 멤버 관리
      • 팀 활동
      • 팀 역할 및 권한
      • 팀 리소스
        • General Runner
        • 팀 변수
        • 요청 프록시 에이전트
      • 실시간 협업
        • 팀 협업
    • 온보딩 체크리스트
      • 기본 개념
      • 온보딩 가이드
    • 조직 관리
      • 조직 관리
      • 조직 역할 및 권한
      • 플랜 관리
        • 조직의 청구 관리자
      • Single Sign-On (SSO)
        • SSO 개요
        • Microsoft Entra ID 구성
        • Okta 구성하기
        • 조직에 대한 SSO 구성
        • 사용자 계정 관리
        • 그룹을 팀에 매핑하기
      • SCIM 프로비저닝
        • SCIM 프로비저닝 소개
        • Microsoft Entra ID
        • Okta
      • 조직 리소스
        • 셀프 호스팅 Runner
  • 청구
    • 개요
    • 크레딧
    • 플랜 업그레이드
    • 대체 결제 방법
    • 구독 관리
    • 유료 팀을 조직으로 이동하기
  • 애드온
    • API Hub
    • Apidog Intellij IDEA 플러그인
    • 브라우저 확장 프로그램
      • Chrome
      • Microsoft Edge
    • 요청 프록시
      • 웹에서의 요청 프록시
      • 공유 문서의 요청 프록시
      • 클라이언트의 요청 프록시
  • 데이터 및 보안
    • 데이터 저장 및 보안
    • 사용자 데이터 개인정보 보호 및 보안
    • 요청 라우팅 및 데이터 보안
  • 참조
    • API 설계 우선 접근 방식
    • Apidog OpenAPI 사양 확장
    • JSONPath
    • XPath
    • 정규 표현식
    • JSON Schema
    • CSV 파일 형식
    • Java 환경 설치
    • Runner 배포 환경
    • Apidog Markdown 구문
    • Apidog Swagger 확장
      • 개요
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 확장
      • 개요
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 지원 센터
  1. Apidog CLI

Apidog CLI 옵션

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 listCLI에서 지원하는 모든 스키마 키를 나열합니다.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 updateJSON 파일로 프로젝트 설정을 업데이트합니다.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 createJSON 파일에서 엔드포인트를 생성합니다.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 createJSON 파일에서 데이터 스키마를 생성합니다.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 listMarkdown 문서를 나열합니다.apidog doc list --project <projectId>
doc getMarkdown 문서 세부 정보를 봅니다.apidog doc get <docId> --project <projectId>
doc createMarkdown 문서를 생성합니다.apidog doc create --project <projectId> --file ./doc.json
doc updateMarkdown 문서를 업데이트합니다.apidog doc update <docId> --project <projectId> --file ./doc.json
doc deleteMarkdown 문서를 삭제합니다.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 createJSON 파일에서 목 규칙을 생성합니다.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 createJSON 파일에서 공통 매개변수를 생성합니다.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 createJSON 파일에서 응답 컴포넌트를 생성합니다.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 createJSON 파일에서 보안 스킴을 생성합니다.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 listAPI 테스트 케이스를 나열하며, 선택적으로 엔드포인트별로 필터링할 수 있습니다.apidog test-case list --project <projectId> --endpoint <endpointId>
test-case category테스트 케이스 카테고리를 나열합니다.apidog test-case category --project <projectId>
test-case getAPI 테스트 케이스 세부 정보를 봅니다.apidog test-case get <caseId> --project <projectId>
test-case createJSON 파일에서 API 테스트 케이스를 생성합니다.apidog test-case create --project <projectId> --file ./case.json
test-case updateAPI 테스트 케이스를 업데이트합니다.apidog test-case update <caseId> --project <projectId> --file ./case.json
test-case deleteAPI 테스트 케이스를 삭제합니다.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 createJSON 파일에서 테스트 데이터 세트를 생성합니다.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 createJSON 파일에서 예약된 작업을 생성합니다.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, --insecureSSL 검증을 비활성화합니다.
--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, --bigintbigint 호환성을 활성화합니다.
--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 foldersOpenAPI 형식으로 선택한 폴더를 내보냅니다.apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json

OAS 내보내기 설정#

export settings를 사용하여 재사용 가능한 OAS 내보내기 설정을 유지 관리하십시오.
명령설명예시
export settings listOAS 내보내기 설정을 나열합니다.apidog export settings list --project <projectId>
export settings createOAS 내보내기 설정을 생성합니다.apidog export settings create --project <projectId> --file ./export-setting.json
export settings getOAS 내보내기 설정을 봅니다.apidog export settings get <settingId> --project <projectId>
export settings updateOAS 내보내기 설정을 업데이트합니다.apidog export settings update <settingId> --project <projectId> --file ./export-setting.json
export settings deleteOAS 내보내기 설정을 삭제합니다.apidog export settings delete <settingId> --project <projectId>
cli-schema get export-settings-createOAS 내보내기 설정 생성용 스키마를 봅니다.apidog cli-schema get export-settings-create
cli-schema get export-settings-updateOAS 내보내기 설정 업데이트용 스키마를 봅니다.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한 브랜치에서 다른 브랜치로 명시적으로 선택한 리소스를 병합합니다.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 aiAI 브랜치를 나열합니다.apidog branch list --project <projectId> --type ai
branch get --type aiAI 브랜치를 봅니다.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 aiAI 브랜치를 업데이트합니다.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 옵션은 --endpoint-ids 1,2, --doc-ids 3,4, --test-suite-ids 5,6과 같이 복수형 이름과 쉼표로 구분된 숫자 ID를 사용합니다.

기타 리소스#

이 명령을 사용하여 프로젝트 확장 리소스 및 외부 연결을 관리하십시오.

사용자 지정 필드#

명령설명예시
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 listWebSocket API를 나열합니다.apidog websocket list --project <projectId>
websocket getWebSocket API 세부 정보를 봅니다.apidog websocket get <websocketId> --project <projectId>
websocket createWebSocket API를 생성합니다.apidog websocket create --project <projectId> --name <name> --url <url>
websocket updateWebSocket API를 업데이트합니다.apidog websocket update <websocketId> --project <projectId> --file ./websocket.json
websocket deleteWebSocket API를 삭제합니다.apidog websocket delete <websocketId> --project <projectId>

Socket.IO API#

명령설명예시
socketio listSocket.IO API를 나열합니다.apidog socketio list --project <projectId>
socketio getSocket.IO API 세부 정보를 봅니다.apidog socketio get <socketioId> --project <projectId>
socketio createSocket.IO API를 생성합니다.apidog socketio create --project <projectId> --file ./socketio.json
socketio updateSocket.IO API를 업데이트합니다.apidog socketio update <socketioId> --project <projectId> --file ./socketio.json
socketio deleteSocket.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 listVault 제공자를 나열합니다.apidog vault list --project <projectId>
vault getVault 제공자 세부 정보를 봅니다.apidog vault get <vaultProviderId> --project <projectId>
vault createVault 제공자를 생성합니다.apidog vault create --project <projectId> --file ./vault.json
vault updateVault 제공자를 업데이트합니다.apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json
vault deleteVault 제공자를 삭제합니다.apidog vault delete <vaultProviderId> --project <projectId>

Git 연결#

명령설명예시
git-connection listGit 연결을 나열합니다.apidog git-connection list --project <projectId>
git-connection getGit 연결 세부 정보를 봅니다.apidog git-connection get <connectionId> --project <projectId>
git-connection createGit 연결을 생성합니다.apidog git-connection create --project <projectId> --file ./git-connection.json
git-connection updateGit 연결을 업데이트합니다.apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json
git-connection deleteGit 연결을 삭제합니다.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를 실행하는 머신에 미리 복사하십시오. 예를 들어 GitHub Actions를 CI/CD 파이프라인으로 사용하는 경우, 워크플로와 동일한 GitHub 리포지토리에 필요한 파일을 복사하십시오.
2
Apidog에서 테스트 시나리오로 이동하여 파일 업로드가 필요한 단계를 찾으십시오. 아래와 같이 Bulk Edit 버튼을 클릭하십시오.
테스트 시나리오 단계 세부 정보의 일괄 편집 버튼
3
CLI 머신에 복사한 파일의 경로를 복사하십시오. 그런 다음 파일 필드 매개변수 값을 CLI 머신의 파일 경로로 바꾸십시오. 예를 들어 GitHub 리포지토리의 data 폴더 아래에 png 파일을 넣은 경우, data/to-be-uploaded.png를 사용하여 참조할 수 있습니다.
일괄 편집 모드의 파일 경로 구성
이 구성을 완료하면 CLI를 통해 파일을 Apidog로 올바르게 보낼 수 있습니다.
이 테스트 시나리오를 로컬에서 다시 실행하려면 매개변수 값의 파일 경로를 로컬 머신의 경로로 다시 수정해야 합니다.

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 대시보드의 "Test Reports" 섹션으로 이동하십시오.
"Team Reports" 열을 찾으십시오.
4
참고: CLI를 통해 업로드된 보고서의 경우 "Tester" 필드는 비어 있는 것으로 표시됩니다.

CLI에서 외부 스크립트/프로그램 사용#

명령 끝에 해당 경로를 추가하여 Apidog CLI 실행 시 외부 스크립트 또는 프로그램을 참조할 수 있습니다. 방법은 다음과 같습니다.
이 예시에서는 CLI가 ./scripts 디렉터리에 있는 프로그램을 참조하도록 지시합니다. 계층 구조를 지정하지 않으면 기본값은 현재 CLI 실행 디렉터리입니다.
이러한 외부 스크립트를 관리하는 주요 방법은 두 가지입니다.

1. 로컬 경로#

로컬 스크립트 관리의 혼란을 방지하려면 다음을 권장합니다.
모든 스크립트 파일을 카테고리별로 구성합니다.
특정 디렉터리에 배치합니다.
CLI 명령에 해당 로컬 경로를 지정합니다.

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"
    }
]
이 옵션은 URL 또는 호스트 이름에 따라 서로 다른 SSL 클라이언트 인증서를 설정하는 것을 지원합니다. 이 옵션은 --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입니다.
3.
"HTTP/1" - HTTP/1.1입니다.
이 매개변수는 다음 구성을 지원합니다.
1.
HTTPS 및 HTTP 요청에 서로 다른 프로토콜 버전 설정:
2.
HTTPS 및 HTTP 모두에 동일한 프로토콜 버전 설정:
3.
HTTPS 및 HTTP 모두에 HTTP/2 설정(지원되지 않는 값은 자동으로 무시됨):

FAQ#

헤더 콘텐츠['Authorization']의 잘못된 문자 오류 메시지를 어떻게 처리합니까?
이 오류는 일반적으로 비ASCII 문자, 줄바꿈 또는 추가 공백과 같은 Authorization 헤더의 잘못된 문자로 인해 발생합니다. Apidog 클라이언트 또는 웹 인터페이스에서 테스트 시나리오를 실행할 때 오류가 발생하지 않는다고 확신하는 경우, 환경의 변수에 INITIAL 값이 설정되어 있는지 확인하고 Authorization 값이 예상 형식과 일치하는지 확인하십시오.
AI 브랜치를 사용하지 않고 프로젝트 데이터를 직접 편집하려면 어떻게 해야 합니까?
안전을 위해 프로젝트 쓰기 권한이 제한될 수 있습니다. 직접 편집이 필요한 경우 프로젝트의 기능 설정을 확인하고 외부 편집 권한을 활성화하십시오.
Modified at 2026-06-09 08:53:32
Previous
Apidog CLI 설치 및 실행
Next
개요
Built with