// API Linter

Der API Linter für
automatisches Style-Guide-Enforcement.

API Linter mit konfigurierbaren Regeln für OpenAPI, AsyncAPI und GraphQL — auch bekannt als Spec-Linter, Quality Gate oder OpenAPI-Validator. Style Guides automatisch durchsetzen, Security-Verstöße erkennen und Spec-Qualität messbar machen — direkt im Merge-Request.

Rule Coverage 150+ RULES
Style, Security und Quality
OpenAPI · AsyncAPI · GraphQL · Custom Rules
150+
Rules out-of-the-box
Native
Engine ohne Vendor-Lock-in
Quality Gate CI/CD
<2s pro Spec validiert
GitHub Actions · GitLab CI · Jenkins · Pre-Commit-Hook
<2s
Validation
0
fehlerhafte Specs in Production
100%
Audit-Coverage

// Definition

Was ein API Linter leistet.

Ein API Linter prüft API-Spezifikationen automatisch gegen ein Regelwerk. Statt manueller Senior-Reviews definiert ein Team einmal seinen Style Guide, und jede Spec wird beim Commit automatisch validiert — in Sekunden statt in Stunden.

Anders als ein generischer YAML-Validator versteht der API Linter die Semantik von OpenAPI 3.x, AsyncAPI 2.x und GraphQL — eine eigene Lint-Engine setzt sowohl mitgelieferte als auch Custom Rules durch.

Schnelles Feedback im Merge-Request statt Kommentare wochenlang nach dem Push: Findings landen als PR-Kommentar, mit Zeilenreferenz und Auto-Fix-Vorschlag.

Policy-Validierung per Linter →

Kernfunktionen

  • 150+ Rules out-of-the-box
  • Custom Rules per YAML/JS definierbar
  • Multi-Format: OpenAPI, AsyncAPI, GraphQL, Swagger
  • Severity-Klassifizierung (Error, Warning, Info)
  • Quality Score pro Spec
  • CI/CD-Integration (GitHub, GitLab, Jenkins)
  • Pre-Commit-Hook und IDE-Plugin
Lint-Ergebnisse im Explorer →

// Drei Probleme

Was der API Linter strukturell löst.

01

Uneinheitliche API-Specs

Jedes Team kocht sein eigenes Süppchen — Naming, Pfad-Strukturen, Auth-Schemas. Der Spec-Linter erzwingt einen konsistenten Style Guide team-übergreifend.

02

Security-Lücken in der Spec

Vergessene Auth-Schemas, ungeschützte sensitive Daten, fehlende Rate-Limits. Der Quality Gate deckt OWASP API Top 10 vor jedem Merge ab.

03

Späte Breaking-Change-Discovery

Fehler kommen sonst erst in Staging auf. In unseren DAX-Konzern-Projekten erreicht die Style-Guide-Compliance erfahrungsgemäß eine sehr hohe Quote — typische Größenordnung rund 99% — mit 15+ Jahren Erfahrung in API-Governance.

// Rule-Kategorien

Der API Linter prüft vier Qualitäts-Dimensionen.

Ein guter API Linter ist mehr als Syntax-Check. Vier Regel-Kategorien decken Style, Security, Performance und Compliance ab — alle individuell aktivierbar und an Team-Standards anpassbar.

SECURITY
Auth, Sensitive Data, OWASP API Top 10
Auth-Schema-Pflicht, sensitive Felder erkennen, Rate-Limiting-Hinweise, OWASP-API-Top-10-Checks.
OAuth2 API Key OWASP
PERFORMANCE
Pagination, Caching, Payload-Size
Cursor-Pagination-Empfehlung, Cache-Header-Pflicht, Response-Schema-Limits, N+1-Pattern-Warnung.
pagination cache ETag
COMPLIANCE
DSGVO, ISO 27001 und Branchen-Standards
Branchen-spezifische Regelwerke für Banken (PSD2-XS2A), Healthcare (HL7 FHIR), Manufacturing (UNECE R155) und Public Sector (XÖV).
DSGVO PSD2 HL7 FHIR ISO 27001 TISAX

// API-Lint-Workflow

Vom Spec-Commit zum grünen Quality Gate.

Der API Linter läuft als Quality Gate in der CI/CD-Pipeline — drei Schritte vom Push bis zum freigegebenen Merge.

1

Spec scannen

Beim Push triggert die CI den Linter. OpenAPI, AsyncAPI oder GraphQL — Format wird automatisch erkannt. Validation läuft in unter 2 Sekunden, auch für Specs mit 500+ Endpoints.

2

Findings priorisieren

Errors blockieren den Merge, Warnings werden im PR kommentiert, Infos landen im Quality Score. Jedes Finding hat Zeilenreferenz, Erklärung und Auto-Fix-Vorschlag — kein Rätselraten.

3

Fixen oder ausnehmen

Entwickler fixen direkt im Editor (IDE-Plugin schlägt Korrekturen vor), oder Architekten genehmigen Ausnahmen mit Begründung. Quality Score steigt, Audit-Trail dokumentiert jede Entscheidung.

// Funktionen

Was der API Linter bietet.

Multi-Format-Validierung

Validiere OpenAPI, AsyncAPI, RAML, SOAP, GraphQL, Swagger und Arazzo Specs — in einem einzigen Linter-Durchlauf, ohne Format-Wechsel.

Quality Score

Automatischer Quality Score (0–100) für jede API-Spec. Tracke die Qualität über alle Versionen hinweg, identifiziere Hotspots, setze Mindest-Thresholds.

CI/CD-Integration

GitHub Actions, GitLab CI, Jenkins, Azure DevOps — der API Linter läuft nativ in jeder Pipeline. Pre-Commit-Hook und IDE-Plugin für sofortiges Feedback.

// Custom Rules

Regeln, die zum eigenen Style Guide passen.

150+ Rules out-of-the-box plus Custom Rules per YAML oder JavaScript. Severity- Klassifizierung (Error, Warning, Info) erlaubt schrittweise Einführung — von „Hinweis" zu „Block-Merge" mit jedem Sprint, ohne Wiki-Pflege.

  • 150+ mitgelieferte Rules out-of-the-box
  • Custom Rules per YAML oder JavaScript definierbar
  • Severity-Klassifizierung (Error / Warning / Info)
  • Auto-Fix-Vorschläge im IDE-Plugin
Naming Conventions
12 Regeln

camelCase fuer Properties

Schema Validation
8 Regeln

Required Fields pruefen

Security Checks
6 Regeln

Auth auf allen Endpoints

Best Practices
15 Regeln

Response Examples vorhanden

// Vergleich

API Linter statt manueller Code-Review oder generischer YAML-Validierung.

Viele API-Teams reviewen Specs händisch oder verlassen sich auf YAML-Syntax-Validatoren — ohne semantisches Verständnis. Ein dedizierter API Linter prüft die OpenAPI-Semantik und erzwingt Style Guides. Für Platform Engineers, API-Architekten und Tech Leads, die Governance skalieren wollen — von 5 auf 500 APIs.

Manueller Code-Review

Senior reviewt jede Spec händisch. Funktioniert bei 5 APIs, kollabiert bei 50+. Subjektive Standards, lange PR-Wartezeiten, vergessene Edge-Cases.

API Linter: automatischer Quality Gate, <2s pro Spec.

YAML-Syntax-Validatoren

Prüfen nur Syntax, nicht Semantik. Eine valide YAML kann eine kaputte API beschreiben — fehlende Auth-Schemas, inkonsistente Naming, Security-Lücken werden übersehen.

API Linter: semantische OpenAPI/AsyncAPI/GraphQL-Validierung.

Wiki-basierte Style Guides

Confluence-Seite mit „API-Standards" — gelesen von 20%, befolgt von 40%. Standards driften, jedes Team kocht eigenes Süppchen, Compliance ist Theater.

API Linter: Style Guide als Code, automatisch erzwungen.

// FAQ

Häufige Fragen zum API Linter.

Kurz beantwortet für Platform-Engineers und API-Architekten.

Kontakt aufnehmen
Ein API Linter prüft API-Spezifikationen automatisch gegen ein konfigurierbares Regelwerk — Style Guide, Security, Performance und Compliance. Er ersetzt manuelle Senior-Reviews durch deterministische Validierung in unter 2 Sekunden, läuft als Quality Gate in CI/CD-Pipelines und erzwingt Standards ohne Wiki-Pflege.
OpenAPI 3.0 und 3.1, Swagger 2.0, AsyncAPI 2.x, GraphQL, RAML, WSDL/SOAP und Arazzo. Für jedes Format wird format-spezifische Linting-Logik angewendet — die OpenAPI-Rules unterscheiden sich von AsyncAPI- oder GraphQL-Rules. Custom Rules sind formatunabhängig oder format-gebunden definierbar.
Der API Linter nutzt eine eigene Lint-Engine im API Portal. Out-of-the-box stehen 150+ Rules bereit, von API-Style-Guides (angelehnt an Zalando RESTful API Guidelines, Google Cloud, Microsoft Azure) bis zu OWASP API Top 10. Custom Rules werden in YAML oder JavaScript definiert — keine externe Engine, kein Vendor-Lock-in, keine Plugin-Inkompatibilitäten bei Format-Erweiterungen.
Native Plugins für GitHub Actions, GitLab CI und Jenkins. Über das CLI funktioniert der Linter mit jeder anderen Pipeline (Azure DevOps, CircleCI, Bitbucket). Pre-Commit-Hooks fangen Findings vor dem Push ab, IDE-Plugins für VS Code und IntelliJ liefern Live-Feedback während der Spec-Bearbeitung.
Ja. Der API Linter unterstützt branchen-spezifische Rule-Pakete: PSD2/XS2A für Banken, HL7 FHIR für Healthcare, UNECE R155 und ISO 21434 für Automotive sowie XÖV für Public Sector. Diese Pakete werden in unseren Projekten mit DAX-Konzernen kontinuierlich gepflegt und stehen Kunden zur Verfügung — als Basis für eigene Compliance-Erweiterungen.

// Mehr entdecken

Verwandte Features.

// Vertiefen

Hintergrund-Artikel zum API Linter.

Praxis-Wissen rund um Style Guides, Spec-First-Workflows und Quality Gates.

Bereit für automatische
Style-Guide-Compliance?

Erlebe den API Linter als Quality Gate für OpenAPI, AsyncAPI und GraphQL — Spec-Fehler erkennen, bevor sie Production erreichen.