Designing API Contracts

Overview

Design RESTful API contracts that map user actions to endpoints with complete schema definitions and comprehensive error handling. Every user action becomes an endpoint; every endpoint has request/response schemas and error handling.

When to Use

• Designing new API endpoints for a feature
• Mapping user actions to HTTP methods and paths
• Creating OpenAPI specifications from requirements
• Defining request/response schemas for endpoints
• Documenting error responses for an API
• Integrating with existing API patterns (brownfield)
• Creating contracts/ directory artifacts

When NOT to Use