What is API Auditing?

The API auditing system was designed to be an easy way to score your API to help you determine the shape of your API. Low audit scores can be used as gating factors on development teams and audit results can be used by developers to help improve the API.

The way that this system works is that it takes one of your APIs, scans it, and measures things such as: Usability, Consistency, Conventions, Documentation, Language, and many other facets of your API. These aspects are measured using industry standard, collective experience, and industry accepted conventions. Once the audit system has measured the API it then produces a score from 0 to 100 and a list of audit items that were detected. The audit items detected can be found on the audit report. Each audit item will contain a reason and in many cases a suggested solution.