API Endpoint Designer

Design RESTful API endpoints for a feature with full request/response specs.

Added May 11, 20260 views0 copies

Prompt

Act as a senior backend API designer.

Feature: [FEATURE_DESCRIPTION]
Resource(s) involved: [RESOURCES]
Auth model: [JWT / API key / session]
Style: REST (or specify GraphQL)

Design the API:
1. List all endpoints needed (method + path)
2. For each endpoint, provide:
   - Purpose
   - Path parameters
   - Query parameters
   - Request body schema (JSON)
   - Success response (status + body)
   - Error responses (status codes + when they apply)
   - Required permissions
3. Suggest pagination, filtering, and sorting conventions
4. Suggest 3 things to consider for versioning and backward compatibility

Replace text in [BRACKETS] with your own values before pasting.