API design principles checked in CI

Lint OpenAPI specs against 32 RFC, pagination, idempotency, and OWASP rules.

Zero external dependencies in Python 3.9+ or right here in your browser.

orders-api.openapi.yaml 22 automated checks
ADP-001 GET /getUserOrders/ CRUD verb in URI
ADP-008 POST /createOrder (400) Missing problem+json
ADP-012 POST /createOrder No Idempotency-Key
ADP-010 GET /v1/orders?cursor=&limit=25 O(1) keyset cursor
ADP-008 422 application/problem+json RFC 9457 valid

Validate an OpenAPI spec

Paste JSON or YAML below, load a preset spec, and export a Markdown or JSON violation report.

Compliance score
--/100
Result
--
Errors
0
Warnings
0
Operations
0
Severity Rule Location Violation and fix Standard
Select Validate OpenAPI Spec to run all 22 automated checks.

Run in CLI, GitHub Actions, and diff checks

Switch workflows to enforce team presets, block breaking changes, and upload SARIF 2.1.0 alerts.

python3 api_validator.py --spec examples/orders-api-good.openapi.yaml --preset strict-public-api
python3 api_validator.py --spec "services/*/openapi.*" --format markdown --output reports/api-lint.md

Runs on Python 3.9+ standard library only with zero pip dependencies for both JSON and YAML OpenAPI specs.

32 API design principles

Filter the complete ruleset by RFC standard, category, or enforcement mode.

Rule Mode Principle and standard Bad example Good example