Ziel und Umfang
Definieren Sie einen API-Vertrag, prüfen Sie Schemas und aufgezeichnete Payloads, erkennen Sie Kompatibilitätsrisiken und dokumentieren Sie die Abnahme.
Dieser Leitfaden macht aus dem beschriebenen Umfang ein überprüfbares Ergebnis. Bewahren Sie Quelle, Zwischenergebnisse und Entscheidungen auf, damit andere nachvollziehen können, was geprüft wurde und warum.
Nachweise vorbereiten und Entscheidungen treffen
Halten Sie eine OpenAPI- oder JSON-Schema-Quelle oder ein repräsentatives JSON-Beispiel bereit.
Legen Sie Kompatibilitätsregeln, Pflichtfelder, Fälle und Abnahmeschwellen fest.
Entscheidung: A) Mit OpenAPI beginnen oder B) mit einem JSON-Beispiel?. Wählen Sie A für einen vorhandenen Vertrag mit Dokumentation und Typen. Wählen Sie B bei reinen Payload-Beispielen und prüfen Sie das abgeleitete Schema vor der Übernahme.
Workflow durchführen
1. Vertrag definieren
Erzeugen Sie Typen und Dokumentation aus OpenAPI oder ein erstes Schema aus einem Beispiel; bewahren Sie Version und Fälle für die Prüfung auf. Verwenden openapi-to-typescript-generator, api-doc-generator, json-schema-generator.
2. Schema und Änderungen validieren
Prüfen Sie normale und fehlerhafte Payloads, erzeugen Sie bei Bedarf Laufzeit-Validierungscode und ordnen Sie Brüche zwischen Versionen ein. Verwenden json-schema-validator, json-schema-to-zod-schema-converter, openapi-diff-breach-detector, api-breaking-changes-detector-migration-planner.
3. Testen und Abnahme festhalten
Prüfen Sie aufgezeichnete Antworten, vergleichen Sie bekannte Payloads und erzeugen Sie Grenz- oder Mutationsfälle; behaupten Sie dabei weder Bereitstellung noch Live-Überwachung. Verwenden api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester, api-mock-server.
Ergebnis vor der Übergabe prüfen
- Die Dokumentation enthält Vertragsversion, Anfrage- und Antwortstrukturen, Pflichtfelder sowie Erfolgs- und Fehlerfälle.
- Gültige Fälle bestehen, ungültige Fälle scheitern verständlich, und Änderungsbericht sowie finale Entscheidung sind festgehalten.
Häufige Fragen
- Stellen diese Tools eine echte API bereit oder überwachen sie sie? Nein. Sie analysieren Spezifikationen, Fälle, Mock-Eingaben und aufgezeichnete Antworten; Bereitstellung und Produktionsüberwachung sind nicht Teil des Ablaufs.
- Was braucht ein Vertragstest? Einen versionierten Vertrag sowie repräsentative Erfolgs-, Validierungsfehler-, Leer-, Grenz- und Autorisierungsfehler-Payloads.
- Wie wird eine Schemaänderung abgenommen? Vergleichen Sie sie mit der Regel, wiederholen Sie die Prüfungen und dokumentieren Sie annehmen, überarbeiten, ablehnen oder versionieren mit Nachweisen.