What problem does it solve?
The jentic-api-scorecard skill addresses the challenge of ensuring the quality, safety, and AI-readiness of your OpenAPI (Swagger) specification by providing a comprehensive scoring service.
Core Features & Use Cases
- AI Readiness Scoring: Measures your OpenAPI spec against the Jentic API AI Readiness Framework (JAIRF) with a grade.
- Automated Linting: Identifies issues such as syntax errors and semantic inconsistencies.
- Machine-Readable Output: Delivers a JSON scorecard that can be used in CI pipelines.
- Custom Reports: Offers various formats for reporting, including JSON, HTML, and markdown.
- LLM Analysis: Provides additional signals using language models to enrich the analysis.
- Integration: Seamlessly integrates with CI/CD pipelines and GitHub Actions.
Quick Start
To score your OpenAPI document using the jentic-api-scorecard skill, execute the following command:
JENTIC_API_KEY=<your-key> npx @jentic/api-scorecard-cli score ./openapi.yaml