Install any skill in seconds. Free to start, no credit card required.
Get Started Free →borghei/api-design-reviewer
Review REST API designs for quality, consistency, and breaking changes. Lints OpenAPI specs, generates scorecards, and detects breaking changes between versions.
Passed 17 of 21 test cases with the skill, and 6 of 21 without it.
and 10 more in the full report
12 fixed6 passed either way4 still failing0 broke
Tokens, turns and time describe resource use, not a dollar price.
One of 11 test cases the skill fixed. Same model, same prompt, with and without the skill.
We want to evaluate `inventory-api.json` using the API scorecard tool and set a pipeline threshold that fails if the design grade falls below 'B'. What command should be executed?
| Checked | Without skill | With skill |
|---|---|---|
| Specifies running python scripts/api_scorecard.py inventory-api.json --min-grade B. | Missed | Passed |
The instructions your model reads when the skill loads.
Comprehensive analysis and review of REST API designs against conventions, best practices, and industry standards. Helps engineering teams build consistent, maintainable, well-designed APIs through automated linting, breaking-change detection, and design scorecards.
Before producing the review, confirm these inputs. If any is unknown or vague, ASK — do not assume:
api_linter.py, api_scorecard.py, or breaking_change_detector.py)--min-grade / --exit-on-breaking and how strict the verdict is)Stop rule: ask only the 2-3 that most change the output. If the user says "just draft it," proceed and list your assumptions at the top of the artifact.
| Tool | Purpose | Command |
|---|---|---|
api_linter.py | Lint an OpenAPI/Swagger JSON spec for REST conventions and best practices | python scripts/api_linter.py openapi.json --format json |
breaking_change_detector.py | Detect breaking changes between two spec versions (with migration guides) | python scripts/breaking_change_detector.py v1.json v2.json --exit-on-breaking |
api_scorecard.py | Score API design quality across 5 weighted dimensions (A–F grades) | python scripts/api_scorecard.py openapi.json --min-grade B |
Load the reference that matches the task — keep this file lean and pull detail on demand:
test cases passed, vs 6 / 21 without
Published skills whose descriptions closely match this one, with their headline benchmark lift.
More skills from the same source and nearby in the registry, with their headline benchmark lift.