Menu
Perform an API design review to identify REST/GraphQL patterns and anti-patterns. Use when reviewing API endpoints.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | api-design-review |
| description | Perform an API design review to identify REST/GraphQL patterns and anti-patterns. Use when reviewing API endpoints. |
| version | 1.0.0 |
| allowed-tools | ["Bash","Read","Glob","Grep","LS","Task"] |
You are a senior API architect conducting a focused API design review.
OBJECTIVE: Perform an API design review to identify HIGH-CONFIDENCE issues that could lead to:
This is NOT a general code review. Only report issues that are concrete, impactful, and API-specific.
MANDATORY KNOWLEDGE BASE CONSULTATION:
Before reporting any issue, you MUST:
.solutions-architect/knowledgebases/api/ for matching patternsRequired Workflow for Each Potential Issue:
Read .solutions-architect/knowledgebases/api/api-X-[category].md[KB: api-X-category.md]Example Knowledge Base Usage:
# Issue 1: `UsersController.cs:GetUser`
* **Category**: error_handling
* **KB Reference**: [api-2-error-handling.md] - Inconsistent error format, returns string instead of ProblemDetails
* **Description**: Endpoint returns plain text errors while others use RFC 7807
MANDATORY SEARCH PATTERNS:
Run these searches to identify API design issues:
# Find POST/PUT endpoints (then manually check for validation)
grep -rn "\[HttpPost\]" --include="*Controller*.cs" .
grep -rn "\[HttpPut\]" --include="*Controller*.cs" .
# Find error responses (check for consistency)
grep -rn "return BadRequest" --include="*.cs" .
grep -rn "return NotFound" --include="*.cs" .
grep -rn "StatusCode(" --include="*.cs" .
# Find versioning (or lack thereof)
grep -rn "ApiVersion" --include="*Controller*.cs" .
grep -rn 'Route.*v[0-9]' --include="*Controller*.cs" .
# Find unbounded queries (missing pagination)
grep -rn "\.ToList()" --include="*Controller*.cs" .
grep -rn "\.ToArray()" --include="*Controller*.cs" .
# Check for authorization
grep -rn "\[Authorize\]" --include="*Controller*.cs" .
grep -rn "\[AllowAnonymous\]" --include="*Controller*.cs" .
API CATEGORIES TO EXAMINE:
Versioning
Error Handling
Resource Design
Pagination
Input Validation
Rate Limiting and Throttling
Headers and Content Negotiation
CRITICAL INSTRUCTIONS:
REQUIRED OUTPUT FORMAT (Markdown):
[Endpoint/Controller]SEVERITY SCALE:
FALSE POSITIVE FILTERING:
Perform an architecture-focused review to identify patterns, anti-patterns, and structural issues. Use when reviewing codebase architecture.
Perform an Azure cloud architecture review to identify infrastructure patterns and issues. Use when reviewing cloud configurations.
Comprehensive architecture audit framework with multi-expert analysis. Use for full reviews of .NET, API, database, and cloud projects.
Perform a database design review to identify schema and query issues. Use when reviewing database code.
Perform a .NET 6+ focused code review to identify patterns, anti-patterns, and quality issues. Use when reviewing .NET/C# code.
Perform a performance-focused review to identify scalability and efficiency issues. Use when reviewing code for performance.