Was macht api-contract-sentinel?
Auditiert APIs gegen OpenAPI-, AsyncAPI-, JSON-Schema-, Protobuf- oder PRD-Verträge, um Abweichungen vor der Veröffentlichung zu erkennen.
Beschreibung
Dieser Skill automatisiert die Überprüfung, ob Ihre API-Implementierung den vereinbarten Spezifikationen entspricht. Er unterstützt eine Vielzahl von Vertragsformaten:
- OpenAPI (früher Swagger)
- AsyncAPI (für ereignisgesteuerte APIs)
- JSON Schema (für Datenvalidierung)
- Protocol Buffers (protobuf)
- PRD-Dokumente (Product Requirements Documents)
Verwendung
Grundlegende Befehle
# Audit gegen OpenAPI-Spezifikation
sentinel audit --contract api-spec.yaml --implementation ./src/routes/
# Audit gegen AsyncAPI
sentinel audit --contract asyncapi.yaml --implementation ./src/events/
# Audit mit PRD-Dokument
sentinel audit --contract requirements.md --implementation ./src/
Integration in CI/CD
Fügen Sie den Audit-Schritt in Ihre Pipeline ein:
# .github/workflows/contract-audit.yml
name: API Contract Audit
on: [push, pull_request]
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run Contract Sentinel
run: |
sentinel audit --contract openapi.yaml --implementation ./dist/
Optionen
| Flag | Beschreibung | Erforderlich |
|---|---|---|
--contract | Pfad zur Vertragsdatei | Ja |
--implementation | Pfad zur Implementierung | Ja |
--format | Ausgabeformat (json, table, html) | Nein (Standard: table) |
--strict | Alle Nichtübereinstimmungen als Fehler melden | Nein |
Beispiele für Ausgaben
✓ OpenAPI-Vertrag erfüllt: GET /users entspricht der Spezifikation
✗ Abweichung erkannt: POST /users erwartet Feld 'email', aber nicht in der Implementierung
Unterstützte Plattformen
- Claude Code
- Cursor
- Codex
- Jede CI/CD-Umgebung (GitHub Actions, GitLab CI, Jenkins)
Lizenz
MIT