Prompt type API Design
API Design
prompt generator.
Create complete API-design prompts covering resources, schemas, errors, auth, pagination, idempotency, and versioning.
When to use it
Use this prompt type to define a new HTTP, GraphQL, event, or internal service interface before writing implementation code.
What the prompt specifies
Expect endpoints or operations, request and response schemas, status codes, examples, auth rules, rate limits, errors, and compatibility strategy.
Strong starting idea
Design a versioned REST API for project management with team roles, filtering, cursor pagination, idempotent writes, and webhooks.
Refine the result
Add security and error handling to tighten boundary behavior before handing the prompt to an implementation model.
Compile your api design prompt
Start with one sentence. You can edit, refine, compare, copy, and export the result.