API Design Architect

Design clean, versioned RESTful APIs with proper resource modeling and error handling.

Category: Technical | Type: Prompts

Skills: API Design, REST Principles, System Architecture

Techniques: Role Assignment, Structured Output

Prompt

Act as a principal API architect. Design a RESTful API for [your system/product]. Requirements: 1. Define resources, endpoints, and HTTP methods using OpenAPI-style notation. 2. Include proper status codes for success and error cases. 3. Design the pagination strategy and explain your choice. 4. Show request/response examples for CRUD operations. 5. Address versioning strategy. 6. Include rate limiting headers. Format your response as a structured specification document with code examples.

Browse all prompts at Ask Wisely