api-design-patterns

What problem does it solve?

This Skill ensures API designs are purpose-built to support specific functionality, preventing generic or misaligned endpoints. It guides the user through understanding API requirements from functionality flows, designing endpoints aligned with project conventions, and providing specific API designs with examples, preventing costly reworks and integration issues.

Core Features & Use Cases

• Context-Aware API Design: Mandates understanding functionality requirements (request, response, error, data flows) and existing API conventions before designing.
• Functionality-to-Endpoint Mapping: Translates user, admin, system, and integration flows into concrete API endpoints.
• Specific API Designs: Provides detailed examples for HTTP methods, paths, request/response schemas, and error handling, aligned with project conventions.
• Authentication & Versioning Guidance: Offers best practices for designing authentication, authorization, and API versioning strategies.
• Use Case: When planning a new feature like "File Upload to CRM," use this skill to design the API endpoints, including request/response schemas and error handling, ensuring they precisely support the file upload and CRM integration functionality.

Quick Start

Design the API endpoints for a new user notification service, focusing on sending and managing notifications.