# Zuplo

> Zuplo API gateway configuration and best practices. Trigger: When configuring Zuplo API gateway.

- Skill: `odjaramillo/zuplo` (Agent Skill, multi-file: 6 files)
- Install (CLI): `npx skillmds@latest add odjaramillo/zuplo`
- Raw SKILL.md: https://api.skillmd.com/api/skills/odjaramillo/zuplo/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- License: Apache-2.0
- Author: odjaramillo (https://skillmd.com/u/odjaramillo)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/odjaramillo/zuplo

---


## Critical Patterns

### Route Configuration (REQUIRED)

```json
{
  "routes": [
    {
      "path": "/api/users",
      "methods": ["GET", "POST"],
      "handler": {
        "module": "$import(@zuplo/runtime)",
        "export": "urlRewriteHandler",
        "options": {
          "rewritePattern": "https://api.example.com/users"
        }
      },
      "policies": {
        "inbound": ["rate-limit", "api-key-auth"]
      }
    }
  ]
}
```

### API Key Auth (REQUIRED)

```typescript
// ✅ ALWAYS: Use built-in API key authentication
export default {
  policies: {
    inbound: [
      {
        name: 'api-key-auth',
        policyType: 'api-key-inbound',
        handler: {
          export: 'ApiKeyInboundPolicy',
          module: '$import(@zuplo/runtime)',
        },
      },
    ],
  },
};
```

---

## Decision Tree

```
Need auth?                 → Use api-key-inbound policy
Need rate limiting?        → Use rate-limit policy
Need caching?              → Use cache policy
Need transforms?           → Use custom policy handler
Need monitoring?           → Enable analytics
```

---

## Resources

- **Gateway Setup**: [gateway-setup.md](gateway-setup.md)
- **GitOps**: [gitops.md](gitops.md)
- **Performance**: [performance.md](performance.md)
- **Security**: [security.md](security.md)