jeremylongshore/tons-of-skills-marketplace / plugins/api-development/api-gateway-builder/skills/building-api-gateway
building-api-gateway
VerifiedCreate API gateways with routing, load balancing, rate limiting, and authentication. Use when routing and managing multiple API services. Trigger with phrases like "build API gateway", "create API router", or "setup API gateway".
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 5.7 KB |
| references/errors.md | markdown | 1.0 KB |
| references/examples.md | markdown | 5.0 KB |
| references/implementation.md | markdown | 1.5 KB |
references/examples.md
View on GitHub# API Gateway Builder Examples
## Route Configuration
```yaml
# gateway/config/routes.yaml
routes:
- prefix: /users
upstream: http://user-service:3001
auth: required
rateLimit: { requests: 1000, window: 60 }
circuitBreaker: { threshold: 5, timeout: 30000 }
- prefix: /orders
upstream: http://order-service:3002
auth: required
rateLimit: { requests: 500, window: 60 }
- prefix: /products
upstream: http://product-service:3003
auth: optional
cache: { ttl: 300, methods: [GET] }
```
## Express Gateway with Proxy
```javascript
const express = require('express');
const { createProxyMiddleware } = require('http-proxy-middleware');
const yaml = require('js-yaml');
const fs = require('fs');
const app = express();
const routes = yaml.load(fs.readFileSync('./config/routes.yaml')).routes;
app.use(correlationId);
app.use(requestLogger);
for (const route of routes) {
const mw = [];
if (route.auth === 'required') mw.push(requireAuth);
if (route.rateLimit) mw.push(rateLimiter(route.rateLimit));
if (route.circuitBreaker) mw.push(circuitBreaker(route.upstream, route.circuitBreaker));
mw.push(createProxyMiddleware({
target: route.upstream,
changeOrigin: true,
pathRewrite: { [`^${route.prefix}`]: '' },
onProxyReq: (proxyReq, req) => {
if (req.user) {
proxyReq.setHeader('X-User-ID', req.user.id);
proxyReq.setHeader('X-User-Roles', req.user.roles.join(','));
}
proxyReq.setHeader('X-Correlation-ID', req.correlationId);
},
}));
app.use(route.prefix, ...mw);
}
```
## Circuit Breaker
```javascript
const CircuitBreaker = require('opossum');
function circuitBreaker(upstream, opts) {
const breaker = new CircuitBreaker(
async (req) => {
const resp = await fetch(`${upstream}${req.path}`, {
method: req.method, headers: req.headers,
body: req.method !== 'GET' ? JSON.stringify(req.body) : undefined,
signal: AbortSignal.timeout(opts.timeout || 10000),
});
if (!resp.ok) throw new Error(`Upstream ${resp.status}`);
return resp;
},
{ timeout: opts.timeout || 10000, errorThresholdPercentage: 50,
resetTimeout: 30000, volumeThreshold: opts.threshold || 5 }
);
breaker.on('open', () => console.warn(`Circuit OPEN: ${upstream}`));
return async (req, res, next) => {
try {
const upstreamRes = await breaker.fire(req);
res.status(upstreamRes.status).json(await upstreamRes.json());
} catch {
if (breaker.opened) {
return res.status(503).json({ title: 'Service Unavailable', retryAfter: 30 });
}
res.status(502).json({ title: 'Bad Gateway' });
}
};
}
```
## Response Aggregation (BFF)
```javascript
app.get('/dashboard', requireAuth, async (req, res) => {
const userId = req.user.id;
const headers = { 'X-Correlation-ID': req.correlationId, 'X-User-ID': userId };
const [user, orders, notifications] = await Promise.allSettled([
fetch(`http://user-service:3001/users/${userId}`, { headers }),
fetch(`http://order-service:3002/users/${userId}/orders?limit=5`, { headers }),
fetch(`http://notification-service:3004/users/${userId}/unread`, { headers }),
]);
res.json({
user: user.status === 'fulfilled' ? await user.value.json() : null,
recentOrders: orders.status === 'fulfilled' ? await orders.value.json() : [],
unreadNotifications: notifications.status === 'fulfilled'
? await notifications.value.json() : { count: 0 },
});
});
```
## Aggregated Health Check
```javascript
app.get('/health', async (req, res) => {
const checks = await Promise.allSettled(
routes.filter(r => r.upstream !== 'internal').map(async (route) => {
const start = Date.now();
const resp = await fetch(`${route.upstream}/health`, { signal: AbortSignal.timeout(3000) });
return { service: route.prefix, status: resp.ok ? 'healthy' : 'unhealthy', latencyMs: Date.now() - start };
})
);
const results = checks.map((c, i) =>
c.status === 'fulfilled' ? c.value : { service: routes[i].prefix, status: 'unreachable' }
);
const overall = results.every(r => r.status === 'healthy') ? 'healthy'
: results.some(r => r.status === 'healthy') ? 'degraded' : 'unhealthy';
res.status(overall === 'unhealthy' ? 503 : 200).json({ status: overall, services: results });
});
```
## curl: Gateway Requests
```bash
# Route through gateway
curl http://localhost:8080/users/42 -H "Authorization: Bearer $TOKEN"
# BFF aggregation
curl http://localhost:8080/dashboard -H "Authorization: Bearer $TOKEN"
# {"user":{...},"recentOrders":[...],"unreadNotifications":{"count":3}}
# Health check
curl http://localhost:8080/health
# {"status":"degraded","services":[{"service":"/users","status":"healthy"},{"service":"/orders","status":"unreachable"}]}
# Circuit open
curl http://localhost:8080/orders/1
# 503 {"title":"Service Unavailable","retryAfter":30}
```
---
*[Tons of Skills](https://tonsofskills.com) by [Intent Solutions](https://intentsolutions.io) | [jeremylongshore.com](https://jeremylongshore.com)*
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |