Skip to content

validate

Zweck

Überprüft die Konfigurationsdatei und alle referenzierten Spezifikationsdateien auf Fehler. Dies ist ein schreibgeschützter Diagnosebefehl — er ändert niemals etwas.

Wann verwenden

  • Nach manueller Bearbeitung von swag2mcp.yaml
  • Vor dem Ausführen von mcp oder update, um Probleme frühzeitig zu erkennen
  • Bei der Fehlerbehebung, warum eine Spec nicht geladen wird
  • In CI/CD-Pipelines zur Validierung von Konfigurationsänderungen

Syntax

bash
swag2mcp validate [path] [flags]

Argumente

ArgumentPositionErforderlichBeschreibung
path1NeinArbeitsbereichsverzeichnis. Wenn nicht angegeben, wird über die Pfadauflösungsregeln ermittelt.

Flags

FlagKurzformTypStandardBeschreibung
--tags-tstring""Nur Specs mit passenden Tags validieren (kommagetrennt)

Wie es funktioniert

bash
swag2mcp validate
swag2mcp validate ./my-workspace
swag2mcp validate --tags=public

Was geprüft wird

PrüfungBeschreibung
YAML-SyntaxDie Konfigurationsdatei muss gültiges YAML sein
KonfigurationsstrukturAlle erforderlichen Felder vorhanden, Typen korrekt
Domain-EindeutigkeitKeine doppelten Domains
Domain-FormatNur Kleinbuchstaben, Ziffern, Bindestriche
Spezifikationsdatei-ExistenzDie location-Datei oder URL muss erreichbar sein
SpezifikationsformatDie Datei muss gültiges OpenAPI 3.x, Swagger 2.0 oder Postman-Collection sein
Auth-EinstellungenAuth-Typ und Konfiguration sind für die ausgewählte Methode gültig
HTTP-ClientHTTP-Client-Einstellungen sind gültig

Was NICHT geprüft wird

Nicht geprüftGrund
Authentifizierungsendpunktevalidate prüft die Auth-Konfigurationssyntax, testet aber keine Anmeldung/Token-Austausch
API-EndpunktverfügbarkeitNur die Spezifikationsdatei-URL wird geprüft, nicht die base_url
base_url-KorrektheitDas Format wird validiert, aber es wird keine Testanfrage gestellt
Mock-Server-Konfigurationbase_mock_url wird nicht auf Konnektivität überprüft

Beispielausgabe

✅ Konfiguration ist gültig.
✓ Spec petstore: OK
✓ Spec meteo: OK
✗ Spec old-api: Datei nicht gefunden

Überprüfung nach dem Befehl

Wenn die Validierung bestanden wird, ist die Konfiguration bereit für mcp, update oder run.

Nuancen

  • Kein Auto-Init: Anders als add, ls oder run führt validate keine automatische Initialisierung durch, wenn die Konfiguration fehlt. Es gibt einen Fehler zurück: "Konfiguration nicht gefunden unter <path>".
  • Netzwerkzugriff: Entfernte Spec-URLs werden während der Validierung abgerufen. Der Befehl kann länger dauern, wenn Spezifikationen auf langsamen Servern gehostet werden.
  • Tag-Filterung: Wenn --tags gesetzt ist, werden nur Specs mit den angegebenen Tags validiert. Andere Specs werden übersprungen.