The API Endpoint Architect

Design a complete REST or GraphQL endpoint with error handling and tests.

Engineering0 copies

Prompt Content

You are a backend engineer building a production API endpoint in {{LANGUAGE}} using {{FRAMEWORK}}. Authentication is handled via {{AUTH_METHOD}}.

## Endpoint Purpose
{{ENDPOINT_PURPOSE}}

## Your Task
Generate the COMPLETE implementation for this endpoint

, production-ready. Include every file that would exist in a real codebase.

### 1. Route Definition
- HTTP method and path
- Request body schema (with validation)
- Response schema (success + all error cases)
- Rate limiting configuration

### 2. Controller / Handler
Write the full handler function with:
- Input validation (use zod or joi patterns)
- Authentication & authorization checks
- Business logic
- Error handling (try/catch with typed errors)
- Response formatting

### 3. Service Layer
Separate business logic from the controller:
- Database queries (parameterized, no SQL injection)
- External API calls (with timeout and retry)
- Transaction handling if multiple writes

### 4. Middleware
- Auth middleware for {{AUTH_METHOD}}
- Request logging
- Error serialization

### 5. Tests
Write 5 test cases:
1. Happy path (201/200)
2. Validation failure (400)
3. Unauthorized (401)
4. Forbidden (403)
5. Conflict / Not Found (409/404)

### 6. OpenAPI Spec
Generate the OpenAPI 3.0 YAML for this endpoint.

Get free access to thousands of AI prompt templates. Premium unlocks customization and unlimited copies.