EasyPlatform api-design
[Architecture] Use when designing or modifying REST API endpoints, controller structure, route patterns, request/response DTOs. Triggers on keywords like "API endpoint", "REST", "controller", "route", "HTTP", "request body", "response".
git clone https://github.com/duc01226/EasyPlatform
T=$(mktemp -d) && git clone --depth=1 https://github.com/duc01226/EasyPlatform "$T" && mkdir -p ~/.claude/skills && cp -r "$T/.claude/skills/api-design" ~/.claude/skills/duc01226-easyplatform-api-design && rm -rf "$T"
.claude/skills/api-design/SKILL.md<!-- SYNC:critical-thinking-mindset -->[IMPORTANT] Use
to break ALL work into small tasks BEFORE starting — including tasks for each file read. This prevents context loss from long files. For simple tasks, AI MUST ATTENTION ask user whether to skip.TaskCreate
<!-- /SYNC:critical-thinking-mindset --> <!-- SYNC:ai-mistake-prevention -->Critical Thinking Mindset — Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence >80% to act. Anti-hallucination: Never present guess as fact — cite sources for every claim, admit uncertainty freely, self-check output for errors, cross-reference independently, stay skeptical of own confidence — certainty without evidence root of all hallucination.
<!-- /SYNC:ai-mistake-prevention --> <!-- SYNC:evidence-based-reasoning -->AI Mistake Prevention — Failure modes to avoid on every task:
- Check downstream references before deleting. Deleting components causes documentation and code staleness cascades. Map all referencing files before removal.
- Verify AI-generated content against actual code. AI hallucinates APIs, class names, and method signatures. Always grep to confirm existence before documenting or referencing.
- Trace full dependency chain after edits. Changing a definition misses downstream variables and consumers derived from it. Always trace the full chain.
- Trace ALL code paths when verifying correctness. Confirming code exists is not confirming it executes. Always trace early exits, error branches, and conditional skips — not just happy path.
- When debugging, ask "whose responsibility?" before fixing. Trace whether bug is in caller (wrong data) or callee (wrong handling). Fix at responsible layer — never patch symptom site.
- Assume existing values are intentional — ask WHY before changing. Before changing any constant, limit, flag, or pattern: read comments, check git blame, examine surrounding code.
- Verify ALL affected outputs, not just the first. Changes touching multiple stacks require verifying EVERY output. One green check is not all green checks.
- Holistic-first debugging — resist nearest-attention trap. When investigating any failure, list EVERY precondition first (config, env vars, DB names, endpoints, DI registrations, data preconditions), then verify each against evidence before forming any code-layer hypothesis.
- Surgical changes — apply the diff test. Bug fix: every changed line must trace directly to the bug. Don't restyle or improve adjacent code. Enhancement task: implement improvements AND announce them explicitly.
- Surface ambiguity before coding — don't pick silently. If request has multiple interpretations, present each with effort estimate and ask. Never assume all-records, file-based, or more complex path.
<!-- /SYNC:evidence-based-reasoning -->Evidence-Based Reasoning — Speculation is FORBIDDEN. Every claim needs proof.
- Cite
, grep results, or framework docs for EVERY claimfile:line- Declare confidence: >80% act freely, 60-80% verify first, <60% DO NOT recommend
- Cross-service validation required for architectural changes
- "I don't have enough evidence" is valid and expected output
BLOCKED until:
Evidence file path (- [ ])file:lineGrep search performed- [ ]3+ similar patterns found- [ ]Confidence level stated- [ ]Forbidden without proof: "obviously", "I think", "should be", "probably", "this is because" If incomplete → output:
"Insufficient evidence. Verified: [...]. Not verified: [...]."
— Domain entity catalog, relationships, cross-service sync (read when task involves business entities/models) (content auto-injected by hook — check for [Injected: ...] header before reading)docs/project-reference/domain-entities-reference.md
Quick Summary
Goal: Design or modify REST API endpoints following the project platform patterns and REST best practices.
MANDATORY IMPORTANT MUST ATTENTION Plan ToDo Task to READ the following project-specific reference docs:
— project patterns and structurebackend-patterns-reference.md →docs/project-config.jsonsection — API conventions (style: REST/GraphQL, authPattern: jwt/api-key, docsFormat: swagger/openapi)apiIf file not found, search for: project documentation, coding standards, architecture docs.
Workflow:
- Design — Define routes using RESTful conventions (plural nouns, proper HTTP methods)
- Implement — Create controller + CQRS command/query with validation and authorization
- Verify — Run API design checklist (routes, auth, validation, paging, error handling)
Key Rules:
- Follow project base controller + CQRS pattern from CLAUDE.md (see docs/project-reference/backend-patterns-reference.md)
- Use proper route naming:
(plural, lowercase, no verbs)/api/{resource} - Validation in Command/Query
, NOT in controllerValidate() - Always add authorization attributes (see docs/project-reference/backend-patterns-reference.md)
- MUST ATTENTION READ
before implementationdocs/project-reference/backend-patterns-reference.md
Be skeptical. Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence percentages (Idea should be more than 80%).
REST API Design
Expert API design agent for the project following platform patterns and REST best practices.
Patterns: Follow CLAUDE.md backend patterns for controller, CQRS command/query, validation, and authorization.
MUST ATTENTION READ before implementation:
docs/project-reference/backend-patterns-reference.md
Route Naming Conventions
| Action | HTTP Method | Route Pattern | Example |
|---|---|---|---|
| List | GET | | |
| Get by ID | GET | | |
| Create/Update | POST | | |
| Delete | DELETE | | |
| Complex Search | POST | | |
| Custom Action | POST | | |
| Nested Resource | GET | | |
⚠️ MUST ATTENTION READ: CLAUDE.md for CQRS command/query DTOs, validation patterns, and authorization patterns.
File Upload Endpoints
[HttpPost("upload")] [RequestSizeLimit(50 * 1024 * 1024)] // 50MB public async Task<IActionResult> Upload([FromForm] UploadCommand command) => Ok(await Cqrs.SendAsync(command)); public sealed class UploadCommand : CqrsCommand<UploadCommandResult> // project CQRS base (see docs/project-reference/backend-patterns-reference.md) { [FromForm] public IFormFile File { get; set; } = null!; [FromForm] public string? Description { get; set; } }
Error Response Format
// Framework handles errors automatically with standard format { "type": "validation", "title": "Validation Error", "status": 400, "errors": { "email": ["Email is required", "Invalid email format"], "firstName": ["FirstName is required"] } } // Business errors { "type": "business", "title": "Business Rule Violation", "status": 422, "detail": "Employee is already assigned to this department" }
API Design Checklist
- RESTful route naming (plural nouns, lowercase)?
- Appropriate HTTP methods?
- Proper authorization attributes?
- Validation in Command/Query Validate()?
- Consistent response format?
- Paging for list endpoints?
- Error handling follows project patterns?
Anti-Patterns
- Verbs in URLs: Use
not/employees/123/activate/activateEmployee - Missing Authorization: Always add authorization attributes (see docs/project-reference/backend-patterns-reference.md)
- Validation in Controller: Move to Command/Query
Validate() - Business Logic in Controller: Keep controllers thin, logic in handlers
- Inconsistent Naming: Follow
pattern{Resource}Controller
Related
arch-cross-service-integration
Closing Reminders
- MANDATORY IMPORTANT MUST ATTENTION break work into small todo tasks using
BEFORE startingTaskCreate - MANDATORY IMPORTANT MUST ATTENTION search codebase for 3+ similar patterns before creating new code
- MANDATORY IMPORTANT MUST ATTENTION cite
evidence for every claim (confidence >80% to act)file:line - MANDATORY IMPORTANT MUST ATTENTION add a final review todo task to verify work quality MANDATORY IMPORTANT MUST ATTENTION READ the following files before starting: <!-- SYNC:evidence-based-reasoning:reminder -->
- MANDATORY IMPORTANT MUST ATTENTION cite
evidence for every claim. Confidence >80% to act, <60% = do NOT recommend. <!-- /SYNC:evidence-based-reasoning:reminder -->file:line - MANDATORY IMPORTANT MUST ATTENTION READ
before starting <!-- SYNC:critical-thinking-mindset:reminder -->docs/project-reference/backend-patterns-reference.md - MUST ATTENTION apply critical thinking — every claim needs traced proof, confidence >80% to act. Anti-hallucination: never present guess as fact. <!-- /SYNC:critical-thinking-mindset:reminder --> <!-- SYNC:ai-mistake-prevention:reminder -->
- MUST ATTENTION apply AI mistake prevention — holistic-first debugging, fix at responsible layer, surface ambiguity before coding, re-read files after compaction. <!-- /SYNC:ai-mistake-prevention:reminder -->