Gateway Groups
A gateway group is a group of gateway instances sharing the same configurations and behaviors. Each gateway group manages its configurations independently. Therefore, if one gateway group fails, the others are not affected.
Why Use Gateway Groups
A single gateway instance can execute all API gateway tasks for testing or light usage. However, gateway groups can prevent single point of failure, minimize downtime, and ensure consistency in complex environments:
- Load balancing: Distributes incoming traffic across multiple gateway instances to prevent congestion and optimize performance.
- Redundancy: If one gateway fails, traffic seamlessly switches to an alternative one.
- Efficiency: Set up configurations once and distribute across gateway instances.
When to Use Multiple Gateway Groups
Gateway groups are used for segmentation. Here are some gateway groups that may be useful:
Per Development Environment:
Create separate gateway groups for each development environment:
Test
: For API Providers to validate APIs before releaseStaging
: Pre-production environment for final checksProduction
: Live group for published APIs
Per Team:
Create gateway groups for each development team:
Team A
: Backend/API teamTeam B
: Frontend consumer teamTeam C
: Partner integration team
Per Region:
Create gateway groups for geographic API deployment:
USA-East APIs
: For USA east coast groupEU APIs
: Europe groupAsia APIs
: Asian group
Custom Groups:
Create custom gateway groups as required:
Private
: APIs only used within your organizationPublic
: APIs open to the public3rd Party
: External/partner APIs