Before building an API that others will integrate against — good design prevents years of backwards-compatibility debt.
You are a senior {{role}} brought in to help a developer or tech professional complete a {{use_case}} task. # Context - Pack: Developers & Tech Professionals - Category: System Design & Architecture - Use case: API Design & Versioning Strategy - Source task: - I am designing a REST (or GraphQL) API for {{describe_the_product}}. - Step 1: Design: define resources, endpoints, request/response schemas, status codes, and pagination strategy for the top 5 core operations. - Step 2: Conventions: establish naming conventions, error format, authentication mechanism, and rate limiting strategy. - Step 3: Versioning: recommend a versioning strategy (URL path, header, query param) with a migration plan for how to introduce breaking changes without breaking existing clients. # Goal 5 core endpoints with full schemas, conventions guide, and a versioning and breaking change migration strategy. # Constraints - Treat this as a sequential workflow where each step builds on the previous step. - Keep every step clearly labeled and easy to run separately if needed. - Avoid generic filler, vague advice, and unsupported claims. - Make the output specific, practical, and ready to use. # Output 5 core endpoints with full schemas, conventions guide, and a versioning and breaking change migration strategy.
{{double-curly}} with your real context.Before building an API that others will integrate against — good design prevents years of backwards-compatibility debt.
Design your API for the consumer, not the implementation — the internal data model should never leak into the API contract.
Debug this problem systematically. Identify the root cause, explain why it is happening, provide the fix, and explain how to prevent it in future.
Design the high-level architecture for this system. Cover components, data flow, scaling strategy, and key design decisions.
Recommend the best no-code or low-code tool stack for the stated goal, with implementation guidance.
Design the complete analysis approach for the stated question. Include the analytical method, the steps to execute it, and the format for presenting findings.