Aneiang.Yarp.Plugin.Cache 2.3.0.30

<div align="center"> <img src="cover-en.png" alt="Aneiang.Yarp — The reverse proxy & API gateway for .NET" width="100%"/>

<br/>

<img src="logo.png" alt="Aneiang.Yarp" width="240" style="border-radius: 15px;"/>

Aneiang.Yarp — Full-featured API Gateway powered by YARP

Plugin Architecture · Dashboard · Dynamic Routing · WAF · Service Discovery · AI Assistant · 2FA · IP Isolation

English | 中文

</div>

Aneiang.Yarp is a production-ready API gateway built on Microsoft YARP 2.3.0. It ships with everything you'd otherwise build yourself: a plugin architecture (11 built-in plugins), a visual management dashboard, WAF, AI assistant, multi-provider service discovery, notifications, health & circuit-breaker monitoring, and one-line client auto-registration.

📖 Documentation · 🚀 Live Demo admin / demo123

Aneiang.Yarp vs. Bare YARP

Architecture

                   +-----------------------------------------------------------+
                   |                 Aneiang.Yarp Gateway (YARP 2.3.0)          |
 +-------------+   |   +------------------+  +-------------------------------+  |
 |  5+ clients  |   |   |  Web Dashboard   |  |  Management API + gRPC host   |  |
 |  (browsers/   |   |   |  Routes/Plugins  |  |  Client auto-registration     |  |
 |   apps)       |-->|   |  WAF / AI / 2FA  |  |                               |  |
 +-------------+   |   +--------+----------+  +--------------+----------------+  |
                   |            +------------------------------------------------+ |
                   |            |                                                  |
                   |   +--------v---------+                                    | |
                   |   |  Plugin Pipeline（11 built-in plugins）                     | |
                   |   |  WAF → RateLimit → Retry → CircuitBreaker →            | |
                   |   |  Compression → Cache → Metrics → ProxyLog              | |
                   |   +--------+---------+                                    | |
                   |            +------------------------------------------------+ |
                   |            |                                                  |
                   |   +--------v---------+   +-------------------------------+  |
                   |   |  YARP Reverse Proxy | → | Target services / clusters |  |
                   |   |  (dynamic routes)  |   |  (via Service Discovery)    |  |
                   |   +--------+---------+   +-------------------------------+  |
                   |            |
                   |   +--------v--------+
                   |   |  Storage: SQLite (SQLCipher AES-256) |
                   +-----------------------------------------------------------+

Highlights

• Plugin architecture — everything is a plugin; 11 first-party plugins provide WAF, rate limiting, retry, circuit breaking, compression, caching, metrics and more. Bring your own IGatewayPlugin in minutes.
• Visual dashboard — clusters, routes, plugins, WAF, health, circuit breakers, logs, notifications, audit trail and config history in one place.
• Runtime dynamic routing — create / edit clusters & routes without restarting; auto-persists and auto-recovers on restart.
• Native YARP config editing — dual-mode form + JSON editor that works directly on the standard YARP schema.
• Multi-provider service discovery — Consul, Nacos, Eureka, Kubernetes, HTTP-JSON, Static.
• One-line client registration — microservices register on startup and unregister on shutdown over REST or gRPC, with heartbeat self-healing.
• AI assistant — manage the gateway by chat; 40 Function-Calling tools with a strict read/write permission split.
• Flexible deployment — Auto / AllInOne / Split / ProxyOnly / DashboardOnly with role-based endpoints.

Quick Start

Minimal

dotnet add package Aneiang.Yarp
dotnet add package Aneiang.Yarp.Dashboard
dotnet add package Aneiang.Yarp.Storage.Sqlite

// Program.cs — Gateway
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddAneiangYarp();
builder.Services.AddAneiangStorage();
builder.Services.AddAneiangYarpDashboard();

var app = builder.Build();
app.UseAneiangYarpDashboard();   // includes MapReverseProxy
app.Run();

Dashboard: http://localhost:5000/apigateway

Microservice — auto-registers on startup, no extra code:

dotnet add package Aneiang.Yarp.Client

builder.Services.AddAneiangYarpClient();

{ "Gateway": { "Registration": { "GatewayUrl": "http://localhost:5000" } } }

Recommended (multi-port + gRPC + hot reload)

var builder = WebApplication.CreateBuilder(args);
builder.UseYarpKestrelAutoConfig();           // multi-port / gRPC support
builder.Services.AddAneiangYarp();
builder.Services.AddAneiangStorage();
builder.Services.AddAneiangYarpDashboard();
builder.Services.AddAneiangYarpDeployment();  // deployment modes + health endpoints

var app = builder.Build();
app.UseAneiangYarpDashboard();
app.Run();

Full step-by-step guide: Quick Start

Package Structure

.NET 8.0 / 9.0.

Feature Overview

Service Discovery

ServiceDiscoveryRefreshService periodically resolves a cluster's destinations from a registry and publishes a new YARP snapshot — no restart. Bound per cluster (service-discovery plugin binding).

Config: Mode (default Static), Endpoint, ServiceName, Namespace (default), Scheme (http), RefreshSeconds (30), RequestTimeoutSeconds (5).

Built-in Plugins

Documentation

Full documentation lives at yarp.aneiang.com.

• Getting Started — Overview · Quick Start
• Gateway Core — Authentication · Dynamic Routing · IP Isolation · Configuration Reference
• Dashboard — Dashboard Overview · Config History
• Security — WAF Firewall · Policy Management
• Monitoring — Health Check · Circuit Breaker · Rate Limiting · Request Logs · Request Retry · Notifications
• Plugins & Pipeline — Plugin System · Middleware Pipeline
• Client SDK — Client Registration
• AI Assistant — AI Assistant
• Advanced — Deployment Modes · Custom Auth · Production Config
• Storage — SQLite Storage

Contributing

We welcome contributions!

1. Fork the repo and create a feature branch (git checkout -b feature/your-feature).
2. Commit with a clear message describing the change and its purpose.
3. Keep the API surface stable — new features should ideally be added as plugins.
4. For new plugins, follow the IGatewayPlugin manifest conventions (id, display name, version, scope, capabilities) and provide a JSON Schema.
5. When changing Dashboard strings, update both zh-CN and en-US language packs.
6. Build the solution with 0 warnings / 0 errors before submitting a Pull Request.

Report bugs and feature requests via GitHub Issues. All first-party packages are MIT-licensed.

NuGet

Package	NuGet
Aneiang.Yarp
Aneiang.Yarp.Dashboard
Aneiang.Yarp.Client
Aneiang.Yarp.Storage.Abstractions
Aneiang.Yarp.Storage.Sqlite
Aneiang.Yarp.Grpc
Aneiang.Yarp.Plugin.Abstractions

.NET 8.0 / 9.0 · YARP 2.3.0

License

MIT

<div align="center" style="display: flex; justify-content: center; align-items: center; gap: 20px; background: #f6f8fa; padding: 20px 30px; border-radius: 12px; border: 1px solid #e1e4e8; box-shadow: 0 2px 8px rgba(0,0,0,0.05);"> <img src="docs/wechat_qrcode.jpg" alt="Official Account QR Code" style="width: 140px; height: 140px; border-radius: 8px; border: 2px solid #d0d7de;" /> <div style="text-align: left;"> <h3 style="margin: 0 0 4px 0; font-size: 22px; font-weight: 600; color: #24292e;"> 递归不爆炸 </h3> <p style="margin: 0; font-size: 16px; color: #586069; max-width: 280px;"> Scan to follow and get more great content </p> </div> </div>

<div align="center">

If this project helps you, ⭐ Star it to support development

</div>