API style guides compared
Compare Haufe-Lexware, Zalando, and Google AIP against executable CI OpenAPI rules.
Enforcement capabilities
How static markdown guides compare with automated Pull Request validation.
| Criteria | Haufe-Lexware Style Guide | Zalando Guidelines | Google AIP | api-design-principles |
|---|---|---|---|---|
| Format | Static Markdown docs | Static docs (+ Zally server) | Static AIP docs (+ proto linter) | Handbook + zero-dependency Python CLI |
| OpenAPI JSON & YAML | No validator | Requires Zally Java/Docker | Protobuf/gRPC focused | Built-in JSON + YAML linter |
| GitHub Action + SARIF | No | No | Custom setup | Built-in action.yml + SARIF 2.1.0 |
| Breaking Change Diff | No | No | buf / proto only | Built-in --diff base head |
| Browser Validator | No | No | No | Client-side GitHub Pages UI |