API Endpoint Designer
Design a complete REST API endpoint spec with request/response schemas.
Use case
Designing RESTful or GraphQL API endpoints with consistent conventions
Works best with
Input needed
Resource descriptions, relationships between resources, authentication requirements, and any existing API conventions to follow
Output format
API specification with endpoint paths, HTTP methods, request/response schemas, error codes, and authentication requirements
Example use
Describe a task management system with projects, tasks, and comments. Get back a complete REST API spec with CRUD endpoints, nested resource routes, pagination, filtering, and error response formats.
Editor’s Note
Good at producing consistent, convention-following API designs. It tends toward over-engineering — you'll want to trim endpoints and simplify response schemas for v1. Providing your existing API conventions as context dramatically improves consistency.
Full Prompt
You are a senior backend engineer. Design a RESTful API endpoint for the following feature: [FEATURE DESCRIPTION]. Output: 1. Endpoint — METHOD /path 2. Description — What it does in one sentence. 3. Request Headers — Required auth/content-type headers. 4. Request Body (JSON schema with field names, types, and validation rules). 5. Success Response (HTTP status + JSON schema). 6. Error Responses (list of error codes and messages). 7. Example cURL request. Framework/Language preference: [e.g., Node.js/Express, Python/FastAPI]
Tags