How-To Guides
This section contains practical, task-oriented guides for API7 Gateway. Each guide focuses on a specific goal and provides step-by-step instructions to accomplish it.
Traffic Management
Control how API7 Gateway handles incoming requests and routes them to upstream services.
- Rate Limiting: Protect upstream services by limiting the number of requests per consumer or IP address.
- Proxy Rewrite: Rewrite request URIs, headers, and methods before forwarding to upstream services.
- Canary Release: Gradually roll out changes by splitting traffic between upstream versions using weighted routing.
- Health Check: Configure active and passive health checks to automatically remove unhealthy upstream nodes.
Plugin Development
Extend API7 Gateway functionality with custom plugins.
- Custom Lua Plugins: Write and deploy custom Lua plugins that run inside the gateway process.
Operations
Manage organizational access control and operational workflows.
- Manage Gateway Groups: Create and manage multiple gateway groups to isolate traffic across environments or teams.
- Use ADC for Declarative Configuration: Manage gateway configuration as code with ADC.
- Configure Secret Management: Integrate external secret managers for sensitive configuration.
- Create a Custom Role: Define permission policies, attach them to a role, and assign the role to a user.
- Design a Custom Role System: Plan a scalable RBAC model for teams, environments, and delegated administration.
Related Resources
- Quick Start: Set up API7 Gateway for the first time.
- Tutorial: Proxying and Managing API Requests: A hands-on tutorial covering basic proxying and plugin management.
- Key Concepts: Understand the core concepts behind API7 Gateway.