What makes an API doc actually complete?
Great API docs let developers integrate without ever having to ask you a question. This calculator scores your documentation across 8 items that developers most commonly look for, on a 100-point scale.
The highest-weighted items — endpoint descriptions, request/response examples, parameter specs, and error code explanations — are each worth 15 points, because these are the things developers check before they ever make their first call. Authentication method, rate limit policy, changelog, and a "try it out" feature are each worth 10 points; lower priority, but still meaningful once you're integrating in production.
If your score is under 60, developers are likely filing support tickets or calling your API incorrectly. Fixing the highest-weighted items first is the most efficient way to raise doc quality.
Frequently Asked Questions
It's built from items common to most API doc formats — REST, GraphQL, and others. Internal-only APIs can relax a few items if needed.
It only costs 10 points, so you can still hit 90 if every other item is covered. Live testing is a relatively lower priority item.
Fill in the highest-weighted items first — request/response examples, parameter specs, and error code descriptions — for the biggest usability gain.