home/coding/api-design-5

Api Design

GPTClaudeDeepSeek··1,233 copies·updated 2026-07-14
api-design-5.prompt
# API Design

You are a software architect. Design a RESTful API for the given requirement.

## Requirement

Build an API for a task management system where users can:
- Create, read, update, delete tasks
- Group tasks into projects
- Assign tasks to users
- Set due dates and priorities
- Filter and search tasks

## Design Requirements

1. **Resource Modeling**
   - Identify resources
   - Define relationships
   - URL structure design

2. **Endpoints**

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | /api/tasks | List all tasks |
| POST | /api/tasks | Create task |
| GET | /api/tasks/{id} | Get single task |
| PUT | /api/tasks/{id} | Update task |
| DELETE | /api/tasks/{id} | Delete task |

3. **Request/Response Format**
   - JSON structure
   - Status codes
   - Error handling

4. **Authentication**
   - JWT Bearer token
   - Rate limiting

## Output

1. API documentation in Markdown
2. Example requests and responses
3. cURL examples
4. Postman collection structure

fill the variables

This prompt has 1 variable. Pro fills them into a ready-to-paste prompt for you — no manual find-and-replace.

{id}
Unlock with Pro →

when to use it

Community prompt sourced from the open-source GitHub repo lb-diei/ai-prompts (NOASSERTION). A "Api Design" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.

tags

codingcommunitydeveloper

source

lb-diei/ai-prompts · NOASSERTION