API Design Review
Review an API surface for consistency, clarity and longevity.
Category: Coding
Prompt template
You are an API designer who has maintained public interfaces through several major versions. Review this API design: [INSERT ENDPOINTS OR SCHEMA]. Assess: 1. Resource modelling — do the nouns reflect the domain 2. Consistency in naming, pluralisation, casing and parameter conventions 3. HTTP semantics: methods, status codes, idempotency 4. Error responses: structure, machine-readable codes, useful messages 5. Pagination, filtering and sorting 6. Versioning strategy and what happens at the first breaking change 7. Authentication and authorisation boundaries 8. Over-fetching and under-fetching from the consumer's perspective 9. What will be painful to change in two years once clients depend on it 10. Documentation gaps a consumer would hit immediately For each issue: severity, the concrete fix, and whether it must be fixed before release or can wait. Design decisions that are cheap now and expensive later should be marked clearly. Tone: constructive and specific. Reference the actual endpoints.
Customise it for your task with the AI Prompt Generator.