Claude Skill MartBrowse skillsWhat is a Skill?
 
← Back to list

API Design Reviewer

Reviews REST APIs by linting OpenAPI specs, detecting breaking changes, and grading design quality A–F.

Web & APIIntermediate★ 24,151⑂ 3,405AI score 8/10Last updated: Aug 9, 2026

What it does

Runs a three-tool review pass over your REST API design:

  • api_linter.py — checks resource naming (kebab-case), field naming (camelCase), HTTP method semantics, status codes, error response shape, and documentation gaps.
  • breaking_change_detector.py — diffs two spec versions to surface removed endpoints, dropped or retyped fields, and newly required fields that would break clients. --exit-on-breaking makes it a CI gate.
  • api_scorecard.py — scores consistency (30%), documentation (20%), security (20%), usability (15%), and performance (15%), returning an A–F grade.

The skill also ships a solid reference section: versioning strategies, pagination patterns (offset/cursor/page), a standard error envelope, auth and rate-limit headers, HATEOAS, idempotency keys, and a safe-vs-breaking change checklist — handy as a starting point for a team API style guide.

Who it's for

  • Backend engineers and tech leads reviewing PRs that add or change endpoints
  • Teams auditing an existing API ahead of a v2 migration
  • Platform/architecture owners establishing shared API conventions

Examples

  1. PR gate: "Lint the openapi.json in this PR and diff it against main for breaking changes" — you get lint findings, a breaking-change list, and a grade in one report.
  2. v2 migration audit: run the scorecard on the legacy spec, extract everything below a B (missing descriptions, unpaginated collections) and turn it into a prioritized fix list.
  3. CI integration: add a GitHub Actions step with --min-grade B and --exit-on-breaking so builds fail when conventions slip.

· · · Install guide · · ·

Install in the Claude app (no terminal)
  1. Download the ZIP with the button below.
  2. In Claude, open Settings → Capabilities and turn on 'Code execution and file creation'. (one time)
  3. Go to Customize → Skills → + → 'Upload a skill' and upload the ZIP.
↓ Download ZIP
Install in Claude Code

Let Claude do it — paste this into Claude Code

Install the skill I found on Claude Skill Mart.
Copy the .gemini/skills/api-design-reviewer folder from the GitHub repo alirezarezvani/claude-skills into my ~/.claude/skills/api-design-reviewer/.
When it's done, tell me in one line what this skill can do.

Install with a command instead

git clone https://github.com/alirezarezvani/claude-skills.git /tmp/claude-skills && mkdir -p ~/.claude/skills && cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/

⚠ This is a third-party skill. Check the source repository before installing.

  1. Open a terminal.
  2. Clone the repo into a temp folder: git clone https://github.com/alirezarezvani/claude-skills.git /tmp/claude-skills
  3. Create the skills directory: mkdir -p ~/.claude/skills
  4. Copy the skill over: cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/
  5. Verify the helper scripts came along: ls ~/.claude/skills/api-design-reviewer/scripts. If they're missing, locate the scripts folder elsewhere in the repo and copy it in.
  6. Make sure Python 3 is available: python3 --version
  7. Restart Claude Code, then ask something like "Review this OpenAPI spec's design and check for breaking changes against v1."
View source on GitHub ↗License: MIT