46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# 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 path-based routing, prefix stripping, and structured logging.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Run locally
|
|
cd app
|
|
go run main.go
|
|
|
|
# Run with Docker
|
|
docker compose up -d
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [Architecture](./architecture.md) - System architecture and component design
|
|
- [Configuration](./configuration.md) - Configuration reference and examples
|
|
- [Usage](./usage.md) - How to use the gateway
|
|
- [Development](./development.md) - Development setup and guide
|
|
- [Deployment](./deployment.md) - Deployment instructions
|
|
|
|
## Features
|
|
|
|
- **Reverse Proxy** Route requests to backend services
|
|
- **Path-based Routing** Configurable route patterns with chi/v5
|
|
- **Prefix Stripping** Remove path prefixes before proxying
|
|
- **Host-based Routing** Virtual hosting support
|
|
- **Middleware Pipeline** Extensible middleware chain (request ID, real IP, logging)
|
|
- **Logging** Structured JSON logging with sensitive field pseudonymization
|
|
|
|
## Health Check
|
|
|
|
The gateway provides a health check endpoint:
|
|
|
|
```
|
|
GET /_/health
|
|
```
|
|
|
|
Returns `200 OK` when the gateway is running.
|