Score My OpenAPI
What Will I Find Inside the Report?
Did You Know?
Only 5% API definitions we receive are fully capable of generating good quality SDKs and documentation. Rest need a bit more love and energy to take them to the next level.
Why a Strong API Definition Matters for Your API
Well-Defined API 🤝 Enhanced Developer Experience
Compatibility with API Tools
When your API definition is standard compliant it can work well across the API tools ecosystem.
Ease of Integration
You can generate top quality SDKs and documentation from the API definition and reduce integration time.
User-Friendly Documentation
An API definition loaded with descriptions, examples and other metadata will make generated documentation much easier for your end-users to understand.
Promotes Consistency
An API definition with consistent naming practices will simplify development and make it less prone to errors.
Audit your API definition
Get a score for your API definition to quickly assess how good your API definition is now and how good it can be. Get a bird's eye view of all issues affecting standard compliance, code and documentation generation. Download a complete in-depth audit report to share with external stakeholders. Discover potential issues with our dedicated Validate option in the Dashboard or use our VS Code extension
Create an action plan
The information from discovery phase will help you prioritize the right issues first: Fix syntax problems Ensure standard compliance Focus next on code generation and documentation Tackle all other issues
.svg)
Auto-Generate DX Components
Once your API definition is ready, you can: Generate and publish client SDKs for your API. Generate HTTP and language-specific documentation with try-it-out. Transform to a different API definition format. And much more.
.svg)
Audit your API definition
Get a score for your API definition to quickly assess how good your API definition is now and how good it can be. Get a bird's eye view of all issues affecting standard compliance, code and documentation generation. Download a complete in-depth audit report to share with external stakeholders. Discover potential issues with our dedicated Validate option in the Dashboard or use our VS Code extension
Multiple API Definition Specification Formats Supported
We support scoring and auditing of all popular API specification formats including OpenAPI, RAML, API Blueprint, WSDL, WADL, Postman Collections, etc.
View all supported formats.
Complete Control Over Scoring
Left some things out on purpose and don't want those issues to count towards your score? Configure the validation as per your needs.
Looking to tighten the scoring by adding your own restrictions? Add your own custom lint rules.
Try APIMatic for free for 14 days and change how developers see your API forever
