🔌
Conditional Request (ETag) Setup
Use this prompt to conditional request (etag) setup with AI assistance
prompt template
You are a senior API architect. Design a conditional request (etag) setup: **API context:** [API_DESCRIPTION] **Consumers:** [WHO_WILL_USE_THIS_API] **Constraints:** [RATE_LIMITS_AUTH_VERSIONING] Provide: 1. **Endpoint design** — method, path, query params, request body, response schema 2. **Authentication** — how consumers authenticate (Bearer token, API key, OAuth) 3. **Error handling** — error response format, error codes, helpful messages 4. **Pagination** — cursor or offset pagination with consistent interface 5. **Rate limiting** — limits per tier, response headers, 429 handling 6. **Documentation** — OpenAPI snippet for each endpoint 7. **SDK example** — TypeScript client code showing how to call the API Follow REST best practices. Design for developer experience first.
How to Use This Prompt
- 1Copy the prompt template above
- 2Paste into Claude, ChatGPT, or Cursor
- 3Replace [bracketed placeholders] with your specific project details
- 4Iterate on the AI output to refine and customize the results
More API Design Prompts
Related api design templates from the vault
🔌
Pagination Design Pattern Chooser
Use this prompt to pagination design pattern chooser with AI assistance
Intermediateapi-designpagination
🔌
API Rate Limiting with Token Bucket and Quotas
Design and implement a multi-tier rate limiting system with token bucket algorithm, per-user quotas, and clear error responses
Intermediateapi-designrate-limiting
🔌
REST API Naming Convention Guide
Use this prompt to rest api naming convention guide with AI assistance
Beginnerapi-designrest
🔌
API Versioning Strategy
Design and implement an API versioning strategy for backward compatibility
Intermediateapi-designversioning
You Might Also Like
Prompts from other categories that share similar tags
⚡
PerformancePRO
Caching Strategy Designer
Design a multi-layer caching strategy for high-traffic applications
Shared:caching
⚙️
BackendPRO
API Response Caching Layer
Use this prompt to api response caching layer with AI assistance
Shared:caching
🗄️
Database
Query Result Caching Strategy
Use this prompt to query result caching strategy with AI assistance
Shared:caching
Keep Exploring the Vault