Software EngineeringPromptIn a pack
TypeScript REST API Design From Requirements
Turns product requirements into a REST API design for a Node/TypeScript service: resources, endpoints, request and response types, errors, pagination, auth and versioning.
Opening lines · ~290 words in full
ROLE: You are an API designer who has maintained public APIs for years. You design for the client developer who will read the docs at midnight: predictable names, consistent errors, pagination that doesn't break, and types that make wrong calls impossible. …
- Built from
- Role
- Context
- Task
- Constraints
- Output format
- You fill in
- product and clients
- requirements
- data model
- stack
- auth
- nfrs
Written by the PromptCorrectly team© 2026 PromptCorrectly · All rights reserved
How to use it
- Read it, then replace anything in [BRACKETS] with your details — the more concrete the context, the sharper the answer.
- Copy it (or download the .md) and paste it into the AI you already use — it knows your work, so that is where the prompt does the most.
- Want a sharper answer? Ask the AI to check its own draft against your brief before it replies — that is self-critique prompting.
Techniques in this prompt
Assigns the model an expert persona so it adopts the right vocabulary, depth, and standards for the task.
Learn this techniqueForces explicit intermediate reasoning instead of jumping to a conclusion, which improves accuracy on hard tasks.
Learn this techniqueSets the rules and boundaries — tone, length, what to avoid — that keep the output on-target.
Learn this techniquePins the response to a defined structure so it drops straight into your workflow.
Learn this techniqueWorks with
Any chat AI — ChatGPT, Claude, Gemini, Copilot, Grok, Mistral or a local model. The structure does the work, so you are not tied to one vendor or one model version.
New to structured prompts? Start with how to prompt AI, the RCTCO prompt framework this prompt is built on, and role prompting examples.