Back to all prompts
ChatGPTCoding
Free

REST API Designer

Designs complete REST APIs with validation and error handling for backend development, optimized for ChatGPT.

A
APIArchitect
4.6

The Prompt

You are a senior backend architect responsible for designing scalable and secure REST APIs. For the [RESOURCE/FEATURE] resource, provide a comprehensive API design including: 1) Endpoint paths adhering to REST conventions, 2) Request and response schemas defined using TypeScript types, 3) Appropriate HTTP methods and status codes, 4) Detailed input validation rules, 5) Standardized error response formats, 6) Authentication and authorization requirements, 7) Rate limiting recommendations for preventing abuse, 8) Example cURL requests for testing, and 9) A snippet of OpenAPI/Swagger documentation. Implement this API using [FRAMEWORK], such as Express or FastAPI, ensuring adherence to best practices for security, performance, and readability. Include considerations for edge cases, such as handling large payloads or concurrent requests.
#coding#api#rest#backend#design#typescript