SecNex API Gateway Documentation

Welcome to the official documentation for the SecNex API Gateway.

Overview

SecNex API Gateway is a high-performance, configurable API gateway built in Go. It provides reverse proxy capabilities with built-in security features including authentication and web application firewall (WAF) functionality.

Quick Start

# Run locally
cd app
go run main.go

# Run with Docker
docker compose up -d

Documentation

Architecture - System architecture and component design
Configuration - Configuration reference and examples
Usage - How to use the gateway
Development - Development setup and guide
Deployment - Deployment instructions

Features

Reverse Proxy Route requests to backend services
Authentication Header-based authentication (API key, session tokens)
WAF Web Application Firewall with method filtering and IP-based access control
Path-based Routing Configurable route patterns with prefix stripping
Middleware Pipeline Extensible middleware chain for custom logic
Logging Structured logging with sensitive field pseudonymization

Health Check

The gateway provides a health check endpoint:

GET /_/health

Returns 200 OK when the gateway is running.

1.3 KiB Raw Blame History