A Service Catalog scorecard helps you evaluate services based on validation criteria. Scorecards help you detect issues, like whether there are services in the catalog that don’t have an on-call engineer assigned, or if you have GitHub repositories with stale pull requests that aren’t getting reviewed or closed.
From the scorecard view, you can view details on either a per-service or per-criteria basis.
Konnect provides several scorecard templates to help ensure your Service Catalog services adhere to industry best practices.
|
Scorecard template |
Description |
|---|---|
| Service documentation | Hosts your documentation files and API specs. |
| Service maturity | Measures performance reflecting industry-defined DORA metrics: deployment frequency, lead time for changes, change failure rate, and time to restore service. |
| Kong best practices | Best practices that we encourage users to follow when using other Konnect applications. |
| Security and compliance | Checks that services are protected through external monitoring and vulnerability management tools. |
To enable a scorecard on a service:
The service documentation template supports the following Spectral recipes:
|
Category |
Description |
Recipe rules |
|---|---|---|
| OAS Recommended |
Uses Stoplight’s style guide. Only considers criteria tagged with "recommended: true".
|
Stoplight Style Guide |
| OWASP Top 10 | Set of rules to check for OWASP security guidelines | OWASP Top 10 API Security Guide |
| URL Versioning | Set of rules to check for versioning | API Versioning Guide |
| Documentation | Set of rules to check for documentation best practices | API Documentation Guidelines |