api-design
API Design
Help me design a RESTful API:
Requirements
- Resource: What entity is this for?
- Operations: What actions are needed (CRUD, other)?
- Relationships: How does it relate to other resources?
- Users: Who will call this API?
Endpoint Design
For each operation, define:
URL Structure
- Resource path (nouns, plural)
- Parameter placement
- Query parameters for filtering/sorting
HTTP Methods
- GET for reads
- POST for creates
- PUT/PATCH for updates
- DELETE for removes
Request Format
- Request body schema
- Required vs optional fields
- Validation rules
Response Format
- Success response schema
- Pagination structure (if list)
- Error response format
Status Codes
- 2xx for success
- 4xx for client errors
- 5xx for server errors
Documentation
Generate OpenAPI/Swagger spec including:
- Endpoint descriptions
- Parameter definitions
- Schema definitions
- Example requests/responses
Best Practices Check
Verify the design follows:
- RESTful conventions
- Consistent naming
- Proper status codes
- Security considerations
More from sunnypatneedi/claude-starter-kit
learning-coach
Master evidence-based study techniques including active recall, spaced repetition, deliberate practice, and accelerated learning. Build efficient learning systems that maximize retention and skill acquisition.
79productivity-gtd
Master the Getting Things Done (GTD) methodology for stress-free productivity. Implement capture, clarify, organize, reflect, and engage workflows with contexts, projects, and weekly reviews.
63journaling
Build effective journaling practices for clarity, growth, and self-awareness. Includes morning pages, gratitude journaling, reflection prompts, problem-solving templates, and habit-building strategies.
39ugc-content-creator
Create short-form video content for TikTok, Instagram Reels, and YouTube Shorts. Master hooks, scripts, trends, platform-native styling, and the organic-to-ad content pipeline for maximum reach and engagement.
29writing-coach
Master clear writing, editing techniques, style improvement, and effective communication. Transform complex ideas into simple, compelling prose that readers understand and remember.
18sales-playbook
Build repeatable sales processes from prospecting through closing. Master qualification frameworks (BANT/MEDDIC), objection handling, pipeline management, discovery questions, and closing techniques for B2B and B2C sales.
12