validate-Befehl

Überprüfen Sie eine Konfigurationsdatei des Daten-API-Generators, ohne die Laufzeit zu starten. Führt eine Abfolge von Prüfungen (Schema, Struktur, Berechtigungen, Konnektivität, Metadaten) aus und gibt einen Beendigungscode für Erfolg (0) oder Fehler (ungleich Null) zurück. Nützlich in CI/CD-Pipelines.

Syntax

dab validate [options]

Schnellblick

Ausgangscodes

CI-Beispiel:

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

dab validate
if %errorlevel%==0 (echo OK) else (echo INVALID CONFIG & exit /b 1)

-c, --config

Pfad zur Konfigurationsdatei. Wenn sie weggelassen wird, sucht dab-config.<DAB_ENVIRONMENT>.json der Validator zuerst, und dann dab-config.json.

Example

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

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

Überprüfungsphasen

Die Überprüfung erfolgt in der Reihenfolge. Wenn eine Phase fehlschlägt, werden spätere Phasen übersprungen.

1. Schema

Überprüft, ob die JSON-Konfiguration dem Schema entspricht.

Regeln

• $schema ist erreichbar oder strukturell gültig
• data-source, runtimeund entities Abschnitte existieren und sind wohlgeformt
• Unerwartete Eigenschaften nicht zugelassen (pro Schema)
• Enumerationswerte (wie database-type) sind gültig.

Fehler und Korrekturen

2. Konfigurationseigenschaften

Überprüft die Konsistenz über das Schema hinaus.

Regeln

• Gültig database-type angegeben
• Für cosmosdb_nosqldatenbank- und GraphQL-Schemapfad sind erforderlich. Je nach Entitäten kann auch ein Container erforderlich sein. REST-Einstellungen werden ignoriert.
• Mindestens ein Endpunkt (REST, GraphQL, MCP) muss aktiviert sein.
• REST/GraphQL-Pfade beginnen mit / und kollidieren nicht
• Legacykennzeichnungen *.disabled geben Warnungen aus, schlagen jedoch nicht fehl.
• Wenn Sie JWT verwenden, müssen sowohl Aussteller als auch Zielgruppe festgelegt werden.

Fehler und Korrekturen

3. Berechtigungen

Überprüft, ob die Berechtigungen jeder Entität gültig sind.

Regeln

• Jeder Eintrag hat eine nicht leere Rolle.

• Aktionen müssen gültig sein:

  • Tabellen/Ansichten: create, read, update, delete, *
  • Gespeicherte Procs: execute, *

• Keine leeren Aktionslisten

• Ein einzelner Aktionssatz muss entweder * ODER explizite Aktionen sein, nicht beide

Fehler und Korrekturen

4. Datenbankverbindung

Überprüft, ob die Datenbankverbindung funktioniert.

Regeln

• Verbindungszeichenfolge kann analysiert werden
• Gültige Anmeldeinformationen
• Datenbank/Container ist vorhanden

Fehler und Korrekturen

5. Entitätsmetadaten

Überprüft Entitätsdefinitionen anhand der Datenbank.

Regeln

• Quellobjekt ist vorhanden
• Tabellen/Ansichten: Gültige Schlüsselfelder, eingeschlossene/ausgeschlossene Felder sind vorhanden.
• Ansichten benötigen immer source.key-fields
• Gespeicherte Prozeduren: Params stimmen mit signatur überein
• Beziehungen: Zielentität vorhanden, Verknüpfen von Feldern, die an Schlüsseln ausgerichtet sind; linking.object muss für n:n vorhanden sein
• Richtlinien verweisen auf gültige Felder
• Zwischenspeichern von TTL nicht negativ

Fehler und Korrekturen

Ausgabebeispiele

Erfolg:

Data API builder <version>
Config is valid.

Versagen:

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

Environment-Specific Dateien

Wenn DAB_ENVIRONMENT diese Einstellung festgelegt ist, validate wird geladen dab-config.<DAB_ENVIRONMENT>.json.

Example

export DAB_ENVIRONMENT=Staging
dab validate

set DAB_ENVIRONMENT=Staging
dab validate

Anwendungsbeispiel

Grundlegend:

dab validate

dab validate

Explizite Datei:

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

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

Multi-Environment:

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

for %E in (Development Staging Production) do ^
  echo Validating %E... ^
  set DAB_ENVIRONMENT=%E ^& dab validate ^|^| exit /b 1

CI fast fail:

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

dab validate
if %errorlevel%==0 (echo OK) else (echo INVALID CONFIG & exit /b 1)

Arbeitsablauf

1. Führen Sie dab validate aus.
2. Beheben der ersten fehlerhaften Phase
3. Erneute Ausführung bis zum Beenden von Code 0
4. Commit für überprüfte Konfiguration