API Design Helper
Design clean, RESTful API endpoints
codingapidesignrestarchitecture
Prompt Template
Design a RESTful API for {system}.
Requirements:
- {requirements}
For each endpoint, provide:
1. HTTP method and path
2. Request body/params schema
3. Response schema with status codes
4. Authentication requirements
5. Rate limiting considerations
Follow REST best practices and use consistent naming.Variables
{system}Example: a task management application
{requirements}Example: CRUD for tasks, user assignment, status transitions, due dates, labels
Example Output
## Task Management API
### POST /api/tasks
Create a new task
```json
{ "title": "string", "description": "string", "assignee_id": "uuid" }
```Tips
- Describe the domain model first
- Mention scaling requirements