borghei/Claude-Skills / engineering/api-design-reviewer
api-design-reviewer
VerifiedReview REST API designs for quality, consistency, and breaking changes. Lints OpenAPI specs, generates scorecards, and detects breaking changes between versions. Use when designing APIs, reviewing contracts, or managing API versioning.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 9.0 KB |
| assets/sample_openapi_v1.json | config | 2.2 KB |
| assets/sample_openapi_v2.json | config | 3.2 KB |
| references/api_antipatterns.md | markdown | 13.4 KB |
| references/rest-design-patterns.md | markdown | 6.6 KB |
| references/rest_design_rules.md | markdown | 10.2 KB |
| references/tooling-ci-and-troubleshooting.md | markdown | 10.4 KB |
| scripts/api_linter.py | script | 37.4 KB |
| scripts/api_scorecard.py | script | 64.4 KB |
| scripts/breaking_change_detector.py | script | 47.9 KB |
assets/sample_openapi_v1.json
View on GitHub{
"openapi": "3.0.3",
"info": {"title": "Users API", "version": "1.0.0"},
"components": {
"securitySchemes": {"bearer": {"type": "http", "scheme": "bearer"}},
"schemas": {
"User": {
"type": "object",
"required": ["id", "email"],
"additionalProperties": false,
"properties": {
"id": {"type": "integer"},
"email": {"type": "string", "format": "email"},
"name": {"type": "string", "maxLength": 80}
}
},
"NewUser": {
"type": "object",
"required": ["email"],
"properties": {
"email": {"type": "string", "format": "email"},
"name": {"type": "string", "maxLength": 80}
}
}
}
},
"paths": {
"/users": {
"get": {
"operationId": "listUsers", "tags": ["users"],
"responses": {"200": {"description": "List", "content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/User"}}}}}}
},
"post": {
"operationId": "createUser", "tags": ["users"],
"security": [{"bearer": []}],
"requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/NewUser"}}}},
"responses": {
"201": {"description": "Created", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/User"}}}},
"409": {"description": "Email already registered"}
}
}
},
"/users/{id}": {
"parameters": [],
"get": {
"operationId": "getUser", "tags": ["users"],
"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "integer"}}],
"responses": {
"200": {"description": "One user", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/User"}}}},
"404": {"description": "Not found"}
}
},
"delete": {
"operationId": "deleteUser", "tags": ["users"],
"security": [{"bearer": []}],
"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "integer"}}],
"responses": {"204": {"description": "Deleted"}, "404": {"description": "Not found"}}
}
}
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |