validate 명령

런타임을 시작하지 않고 데이터 API 작성기 구성 파일의 유효성을 검사합니다. 검사 시퀀스(스키마, 구조, 사용 권한, 연결, 메타데이터)를 실행하고 성공(0) 또는 실패(0이 아닌)에 대한 종료 코드를 반환합니다. CI/CD 파이프라인에서 유용합니다.

Syntax

dab validate [options]

한눈에 보기

종료 코드

CI 예제:

dab validate && echo "OK" || { echo "INVALID CONFIG"; exit 1; }

-c, --config

구성 파일의 경로입니다. 생략하면 유효성 검사기가 먼저 dab-config.json찾습니다dab-config.<DAB_ENVIRONMENT>.json.

Example

dab validate --config ./dab-config.prod.json

유효성 검사 단계

유효성 검사는 순서대로 수행됩니다. 한 단계가 실패하면 이후 단계를 건너뜁니다.

1. 스키마

구성 JSON이 스키마와 일치하는지 확인합니다.

규칙

• $schema 연결할 수 있거나 구조적으로 유효합니다.
• data-source, runtime및 entities 섹션이 존재하며 올바른 형식입니다.
• 허용되지 않는 예기치 않은 속성(스키마당)
• 열거형 값(예: database-type)이 유효합니다.

오류 및 수정

2. 구성 속성

스키마 이외의 일관성을 확인합니다.

규칙

• 유효한 database-type 제공
• 의 경우 cosmosdb_nosql데이터베이스 및 GraphQL 스키마 경로가 필요합니다. 엔터티에 따라 컨테이너가 필요할 수도 있습니다. REST 설정은 무시됩니다.
• 하나 이상의 엔드포인트(REST, GraphQL, MCP)를 사용하도록 설정해야 합니다.
• REST/GraphQL 경로는 시작 / 하며 충돌하지 않습니다.
• 레거시 플래그는 *.disabled 경고를 내보내지만 실패하지 않습니다.
• JWT를 사용하는 경우 발급자와 대상 그룹을 모두 설정해야 합니다.

오류 및 수정

3. 사용 권한

각 엔터티의 권한이 유효한지 확인합니다.

규칙

• 각 항목에는 비어있지 않은 역할이 있습니다.

• 작업은 유효해야 합니다.

  • 테이블/뷰: create, read, update, delete, *
  • 저장된 프록시: execute, *

• 빈 작업 목록 없음

• 단일 작업 집합은 둘 다 아닌 OR 명시적 작업이어야 합니다 * .

오류 및 수정

4. 데이터베이스 연결

데이터베이스 연결이 작동하는지 확인합니다.

규칙

• 연결 문자열 구문 분석 가능
• 유효한 자격 증명
• 데이터베이스/컨테이너가 있음

오류 및 수정

5. 엔터티 메타데이터

데이터베이스에 대한 엔터티 정의를 확인합니다.

규칙

• 원본 개체가 있음
• 테이블/뷰: 유효한 키 필드, 포함/제외된 필드가 있음
• 보기는 항상 필요 source.key-fields
• 저장 프로시저: 매개 변수가 서명과 일치합니다.
• 관계: 대상 엔터티가 존재하고 연결 필드가 키와 일치합니다. linking.object는 다대다에 존재해야 합니다.
• 정책 참조 유효한 필드
• TTL을 음수가 아닌 캐싱

오류 및 수정

출력 예제

성공:

Data API builder <version>
Config is valid.

실패:

Data API builder <version>
Error: View 'sales_summary' missing required key-fields.
Config is invalid.

Environment-Specific 파일

설정된 경우 DAB_ENVIRONMENT .를 validate 로드합니다 dab-config.<DAB_ENVIRONMENT>.json.

Example

DAB_ENVIRONMENT=Staging dab validate

사용 예시

기초의:

dab validate

명시적 파일:

dab validate --config ./configs/dab-config.test.json

다중 환경:

for env in Development Staging Production; do
  echo "Validating $env..."
  DAB_ENVIRONMENT=$env dab validate || exit 1
done

CI 빠른 실패:

dab validate && echo "OK" || { echo "INVALID CONFIG"; exit 1; }

워크플로

1. dab validate을 실행합니다.
2. 첫 번째 실패 단계 수정
3. 종료 코드가 0이 될 때까지 다시 실행
4. 유효성이 검사된 구성 커밋