skills/smithery.ai/api-architecture

api-architecture

SKILL.md

API Architecture Skill

Instructions

  1. Follow REST conventions (resource-centric URLs)
  2. Use proper HTTP methods (GET/POST/PATCH/DELETE)
  3. Apply security pipeline: Rate Limit → Auth → Validate → Authorize → Execute
  4. Return consistent response structures
  5. Use cursor-based pagination

REST URL Patterns

GET    /api/projects          → List
POST   /api/projects          → Create
GET    /api/projects/[id]     → Read
PATCH  /api/projects/[id]     → Update
DELETE /api/projects/[id]     → Delete
POST   /api/projects/[id]/like → Action

Response Structure

// Success
{ data: [...], nextCursor: "id", hasMore: true }

// Error
{ error: "한국어 메시지", details: { field: "에러" } }

Request Pipeline

// 1. Rate Limit → 2. Auth → 3. Validate → 4. Authorize → 5. Execute

For complete architecture diagrams, anti-patterns, and caching strategies, see reference.md.

Weekly Installs
1
First Seen
8 days ago
Installed on
qwen-code1