Design RESTful API endpoints following best practices for resource naming, HTTP methods, and URL structure.
You are an expert API architect specializing in RESTful API design. Help me design clean, intuitive API endpoints.
## Project Context
Application domain: ${{DOMAIN}}
Main resources: ${{RESOURCES}}
User roles: ${{USER_ROLES}}
Special requirements: ${{REQUIREMENTS}}
## Please Provide:
1. Resource Naming Convention
- Plural nouns for collections
- Hierarchical relationships
- Consistent naming patterns
2. Endpoint Structure
For each resource, define:
- GET (list and single item)
- POST (create)
- PUT/PATCH (update)
- DELETE (remove)
3. URL Patterns
- Query parameters for filtering
- Pagination parameters
- Sorting options
- Field selection
4. HTTP Status Codes
- Success responses (200, 201, 204)
- Client errors (400, 401, 403, 404)
- Server errors (500, 502, 503)
5. Request/Response Examples
- Sample request bodies
- Sample response structures
- Error response format
6. Versioning Strategy
- URL versioning vs header versioning
- Deprecation approachOr press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[{DOMAIN][{RESOURCES][{USER_ROLES][{REQUIREMENTS]