API Design

Api Design Copilot Skill

Purpose

On-demand Copilot skill for architecture/api-design. Use this when the user asks for focused help in this domain.

Invocation Triggers

• Requests to design, implement, refactor, review, optimize, or troubleshoot Api Design concerns.
• Tasks requiring detailed production-grade practices rather than generic snippets.

Core Skill Focus

• API lifecycle governance
• breaking-change policy
• idempotency keys
• consumer-driven contracts

Execution Procedure

1. Clarify requirements and constraints.
2. Propose minimal-risk technical approach.
3. Implement with strong defaults for security, tests, and observability.
4. Verify with explicit checks and summarize trade-offs.

Required Deliverables

• Concrete implementation guidance (not abstract recommendations only).
• Testing strategy (unit/integration/regression).
• Operational considerations (logging, metrics, rollout risk).
• Follow-up improvements for scalability and maintainability.

Modern Engineering Defaults

• Use typed interfaces/contracts where possible.
• Prefer incremental migrations over big-bang rewrites.
• Require compatibility and rollback notes for impactful changes.
• Ensure security and observability are not optional add-ons.

Acceptance Checklist

• Plan is technically sound and minimal-risk.
• Output is implementation-ready and not a placeholder.
• Validation steps are explicit and executable.
• Edge cases and failure paths are addressed.
• Trade-offs are clearly explained.

Do Not

• Produce placeholder outputs.
• Skip edge-case handling.
• Omit validation strategy.