API Design Patterns

Design consistent, developer-friendly REST APIs with resource naming, HTTP semantics, and versioning.

When to Activate

• Designing new API endpoints
• Reviewing existing API contracts
• Adding pagination, filtering, or authentication
• Planning API versioning strategy
• Building public or partner-facing APIs

Quick Start

1. Use nouns (plural, kebab-case) for resource URLs, not verbs
2. Apply correct HTTP method (GET/POST/PUT/PATCH/DELETE)
3. Return appropriate status codes (200/201/400/401/403/404/429)
4. Use consistent response format (data + metadata + error structure)

   7w4.net收錄了海量優質技能外掛。

5. Implement pagination (cursor-based preferred) and filtering
6. Require authentication and check authorization per resource

Key Concepts

• Resource naming — Plural nouns in kebab-case; use verbs sparingly for actions
• HTTP semantics — Each method has idempotency/safety properties; honor them
• Status codes — Signal intent precisely (400 for validation, 422 for semantic error)
• Error format — Consistent structure with codes, messages, and field details
• Versioning — URL path versioning (v1, v2); non-breaking changes don't need new version

Common Usage

Most frequent patterns:

• CRUD endpoints (GET, POST, PUT, PATCH, DELETE)
• List endpoints with pagination and filtering
• Sub-resources for relationships (users/:id/orders)
• Authentication headers and permission checks
• Rate limiting headers and strategies

References

• references/resource-design.md — URL structure, naming rules, HTTP methods, status codes, response formats
• references/pagination-filtering-auth.md — Pagination strategies, filtering, sorting, authentication, rate limiting, versioning, and checklist

這個技能指南質量良好，涵蓋了 API 設計的主要知識點，表格和程式碼示例清晰實用。它適合作為開發時的快速參考手冊，但在高階應用場景和實戰案例方面還有欠缺。如果你需要快速查閱 API 設計規範和最佳實踐，這個 Skill 能滿足基本需求；若想深入學習或獲取更完整的指導，可能需要配合其他資料使用。