AI Skill MartBrowse skillsPromptsProgramsLearnWhat is a Skill?
 
← Back to list

API Design Reviewer

Reviews REST APIs by linting the OpenAPI spec, detecting breaking changes, and grading design quality.

Dev & CodingIntermediate★ 24,151⑂ 3,405AI score 7/10Last updated: Aug 9, 2026

What it does

  • Lints an OpenAPI/Swagger spec for resource naming (kebab-case), field naming (camelCase), HTTP method usage, status codes, error-format consistency, and missing documentation.
  • Diffs two spec versions to surface breaking changes — removed endpoints, dropped or retyped fields, newly required fields — and can gate CI with --exit-on-breaking.
  • Produces an A–F scorecard weighted by consistency (30%), documentation (20%), security (20%), usability (15%), and performance (15%).
  • Supplies the review rubric itself: versioning strategies, pagination patterns, standard error envelopes, auth and rate-limit headers, caching, and a list of anti-patterns.

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.
  • Orgs that want API standards enforced by checks rather than a wiki page.

Examples

  1. Run python3 scripts/api_linter.py openapi.json --format json -o lint.json and paste the findings into the PR review.
  2. Compare v1 and v2 specs to list breaking changes, decide what needs a version bump, and draft a migration note.
  3. Wire the scorecard into CI with --min-grade B so builds fail when design quality slips.

· · · Install guide · · ·

Try it now, no install

Paste this into Claude to use the skill without installing anything.

Read the instructions in this file and follow them to help me:
https://raw.githubusercontent.com/alirezarezvani/claude-skills/HEAD/.gemini/skills/api-design-reviewer/SKILL.md

What I want: (describe your task here)

If Claude can't open the link, open it yourself and paste the contents instead.

↓ If it works for you, download the ZIP below and install it. Then it runs on its own — no pasting each time.

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 AI 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: git clone https://github.com/alirezarezvani/claude-skills.git
  3. Create the skills folder: mkdir -p ~/.claude/skills
  4. Copy the skill: cp -r claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/
  5. Verify that scripts/api_linter.py, scripts/breaking_change_detector.py, and scripts/api_scorecard.py exist under ~/.claude/skills/api-design-reviewer/ (if not, locate them elsewhere in the repo and copy them in).
  6. Confirm Python 3 is installed: python3 --version.
  7. Restart Claude Code and ask: "Review the API design in this openapi.json."
View source on GitHub ↗License: MIT