api-response-optimization
Optimizes API performance through payload reduction, caching strategies, and compression techniques. Use when improving API response times, reducing bandwidth usage, or implementing efficient caching.
When & Why to Use This Skill
This Claude skill provides comprehensive strategies and code implementations for optimizing API performance. It focuses on reducing payload sizes through sparse fieldsets, implementing efficient HTTP caching mechanisms like ETags, and enabling response compression to significantly improve response times and reduce bandwidth consumption for modern web services.
Use Cases
- Case 1: Reducing mobile application data usage by implementing sparse fieldsets to allow clients to fetch only the specific data fields they need.
- Case 2: Improving web application loading speeds by configuring HTTP caching headers such as ETag and Cache-Control to prevent unnecessary data re-transmissions.
- Case 3: Decreasing server bandwidth costs and improving latency by enabling Gzip or Brotli compression for large JSON payloads in high-traffic environments.
- Case 4: Establishing performance benchmarks and optimization checklists for RESTful APIs to ensure consistent sub-100ms response times and efficient resource utilization.
| name | api-response-optimization |
|---|---|
| description | Optimizes API performance through payload reduction, caching strategies, and compression techniques. Use when improving API response times, reducing bandwidth usage, or implementing efficient caching. |
API Response Optimization
Reduce payload sizes, implement caching, and enable compression for faster APIs.
Sparse Fieldsets
// Allow clients to select fields: GET /users?fields=id,name,email
app.get('/users', async (req, res) => {
const fields = req.query.fields?.split(',') || null;
const users = await User.find({}, fields?.join(' '));
res.json(users);
});
HTTP Caching Headers
app.get('/products/:id', async (req, res) => {
const product = await Product.findById(req.params.id);
const etag = crypto.createHash('md5').update(JSON.stringify(product)).digest('hex');
if (req.headers['if-none-match'] === etag) {
return res.status(304).end();
}
res.set({
'Cache-Control': 'public, max-age=3600',
'ETag': etag
});
res.json(product);
});
Response Compression
const compression = require('compression');
app.use(compression({
filter: (req, res) => {
if (req.headers['x-no-compression']) return false;
return compression.filter(req, res);
},
level: 6 // Balance between speed and compression
}));
Performance Targets
| Metric | Target |
|---|---|
| Response time | <100ms (from 500ms) |
| Payload size | <50KB (from 500KB) |
| Server CPU | <30% (from 80%) |
Optimization Checklist
- Remove sensitive/unnecessary fields from responses
- Implement sparse fieldsets
- Add ETag/Last-Modified headers
- Enable gzip/brotli compression
- Use pagination for collections
- Eager load to prevent N+1 queries
- Monitor with APM tools
Best Practices
- Cache immutable resources aggressively
- Use short TTL for frequently changing data
- Invalidate cache on writes
- Compress responses >1KB
- Profile before optimizing