Guide

Welcome to the API Gateway guide! This documentation will help you get started with API Gateway and learn how to use its features.

What is API Gateway?

API Gateway is an easy, powerful, and flexible self-hosted API gateway built with Go. It provides:

• Simple Configuration: YAML-based configuration that's easy to understand and maintain
• Flexible Routing: Support for prefix and regex-based path matching
• Path Rewriting: Advanced path rewriting rules for request transformation
• Plugin System: Extensible plugin architecture for custom functionality
• Health Checks: Built-in health check for gateway and backend services
• Service Discovery: DNS-based service discovery
• Authentication: Support for various authentication methods

Quick Navigation

• Quick Start - Get up and running in minutes
• Installation - Installation methods and requirements
• Configuration - Complete configuration reference
• Routing - Learn about routing and path matching
• Load Balancing - Load balancing algorithms and configuration
• Plugins - Plugin packages (overview, Base URI, rate limiting, JSON audit)
• Health Check - Health check configuration
• Examples - Real-world examples and use cases
• TODO List - Development roadmap and planned features

Getting Help

• GitHub Issues - Report bugs or request features
• GitHub Discussions - Ask questions and share ideas