Upload your OpenAPI or Swagger spec and get a 0-100 developer experience score with specific, prioritized fixes in under 10 seconds.
Every score maps to a specific fix in your spec file.
Endpoint descriptions, response examples, error codes, parameter documentation. The foundation every tool builds on.
Security schemes, auth flow clarity, credential acquisition guide, token refresh documentation.
Python, Node.js, and cURL examples embedded in the spec via x-code-samples.
Error coverage including default responses, consistent error format, troubleshooting guidance per endpoint.
Rate limit documentation, specific numbers, retry strategy, and response headers.
PCI DSS, SOC 2, GDPR/CCPA, transport security, idempotency, webhook security. Scored separately from the base 100.
These scores reflect what is in the OpenAPI spec file, not the documentation portal.
| API | Score | Grade | Endpoints |
|---|---|---|---|
| Stripe | 51/100 | D | 587 |
| GitHub | 45/100 | F | 1,079 |
| Twilio | 36/100 | F | 197 |
| Petstore (reference) | 74/100 | B | 4 |
Clone the repo, run ./start.sh, and open the web interface at localhost:3008. Full analysis, PDF export, no data leaves your machine.
Run python -m app.cli analyze spec.yaml --json and set a score threshold in your CI config. Fail the build when documentation quality drops.
POST your spec to /api/v1/analyze/upload and get a structured JSON report back. Integrate into your existing tooling.
API-Clarity is free and open source. MIT licensed.