Api Design Reviewer

Analyzes REST API designs for convention violations, breaking changes, and quality metrics. Detects inconsistent naming, missing documentation, and unsafe changes before APIs ship. Use when reviewing API PRs, auditing existing APIs, or establishing team standards.

skills.sh installs: 800
GitHub stars: 29.5K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add alirezarezvani/claude-skills --skill api-design-reviewer --agent claude-code

Installs into .claude/skills of the current project.

Files

API Design Reviewer

Tier: POWERFUL
Category: Engineering / Architecture
Maintainer: Claude Skills Team

Overview

The API Design Reviewer skill provides comprehensive analysis and review of API designs, focusing on REST conventions, best practices, and industry standards. This skill helps engineering teams build consistent, maintainable, and well-designed APIs through automated linting, breaking change detection, and design scorecards.

Quick Start — run the tools first

# 1. Lint an OpenAPI/Swagger spec for convention violations
python3 scripts/api_linter.py openapi.json --format json -o lint.json

# 2. Detect breaking changes between two spec versions (gate: exits non-zero with --exit-on-breaking)
python3 scripts/breaking_change_detector.py openapi-v1.json openapi-v2.json --format json --exit-on-breaking -o breaking.json

# 3. Score overall design quality (gate: --min-grade fails below threshold)
python3 scripts/api_scorecard.py openapi.json --format json --min-grade B -o scorecard.json

SKILL.md on GitHub

Sponsors

Promote your product hereReach 125k+ visitors monthly Promote your product hereReach 125k+ visitors monthly