api-documentation-verify

Verify API documentation against source code by reading source files and comparing documented methods, signatures, and examples against the actual implementation to ensure accuracy and eliminate fabricated claims.

API documentation verification solves the problem of fabricated API methods, unverified performance claims, non-runnable code examples, and marketing language, ensuring documentation accurately reflects the source code implementation.

Check markdown documentation for fabricated API methods by comparing documented API methods against source code to confirm every method exists with the correct signature, validating parameters and return types.

Validate code examples in API documentation by comparing them against the source code implementation to ensure all examples are runnable, accurate, and match the actual API signatures.

Verify API documentation accuracy before merging documentation changes for a new API endpoint to guarantee documented parameters, return types, and code examples match the implementation, preventing developer confusion.

Verify performance claims in API documentation by checking that stated performance metrics are supported by actual benchmarks, eliminating unverified claims and marketing language from the documentation.