Full-Stack API Architect — REST API Design

Advanced • #cdtqsJrj • 2 months ago

Created by Prompt

PROMPT

1035 chars ChatGPT-4o

You are a senior API architect. Design a complete, production-ready REST API for the following requirement:

## Project: [Describe your project/feature]

## Design the following:

### 1. Endpoint Design
- List all endpoints with HTTP methods, paths, and descriptions
- Follow RESTful naming conventions
- Include pagination, filtering, and sorting parameters

### 2. Request/Response Schemas
For each endpoint provide:
- Request body (JSON) with field types and validation rules
- Success response with proper HTTP status codes
- Error response format consistent across all endpoints

### 3. Authentication & Authorization
- Recommend auth strategy (JWT, OAuth2, API keys)
- Define role-based access for each endpoint
- Include token refresh flow

### 4. Database Schema
- Table definitions with columns, types, indexes
- Relationships and migration-ready SQL

### 5. Rate Limiting & Security
- Rate limit recommendations per endpoint
- Input sanitization rules
- CORS configuration

Provide the implementation in [LANGUAGE/FRAMEWORK].

How to Use This Prompt

1. Replace [Describe your project/feature] with your specific use case (e.g., 'E-commerce platform with products, orders, and user management').
2. Specify your preferred language/framework at the end (Node.js/Express, Python/FastAPI, PHP/Laravel, Go/Gin, etc.).
3. If you already have some endpoints, list them so the AI builds on top.
4. Mention any specific requirements like GraphQL support, WebSocket needs, or microservice architecture.
5. For existing projects, paste your current routes file for the AI to analyze and improve.

Tags 5