Nexus Gateway Documentation

Welcome to the official documentation for Nexus Gateway — a lightweight, developer-first API gateway for managing authentication, rate limiting, and traffic routing across microservices.

This documentation covers core concepts, configuration guides, and integration patterns for teams building on the Nexus Gateway platform.

Concepts

• What is Nexus Gateway?
  • Core Responsibilities
  • How Nexus Gateway Fits Into Your Architecture
  • When to Use Nexus Gateway
• Authentication
  • Supported Authentication Methods
  • How Authentication Failures Are Handled
  • Combining Authentication with Authorisation
• Rate Limiting
  • Why Rate Limiting Matters
  • How Nexus Gateway Counts Requests
  • Rate Limit Identifiers
  • Rate Limit Response Headers
  • Configuring Rate Limits
• Request Routing
  • Route Matching
  • Route Priority
  • Upstream Configuration
  • Load Balancing
  • Health Checks

Guides

• Getting Started
  • Prerequisites
  • Step 1 — Download Nexus Gateway
  • Step 2 — Create a Configuration File
  • Step 3 — Start the Gateway
  • Step 4 — Send a Test Request
  • Step 5 — Check the Admin API
  • Next Steps
• Configuring Routes
  • A Route for a Real Service
  • Manipulating Request Headers
  • Handling Multiple Upstreams for the Same Path
  • Testing Routes Without Restarting