基于C#微服务的API网关：完整指南

为什么你的C#项目需要API网关？

想象一下，你正在用C#构建一个现代Web应用程序。你有用户服务、订单服务、支付服务——每个服务都运行在自己的端口上，甚至可能在不同的服务器上。客户端应用程序（前端或移动应用）必须知道所有这些地址、数据格式和认证协议。真是个噩梦，对吧？

这时，面向C#服务的API网关登场了——它是一个统一的入口点，承担了所有“脏活累活”：路由、响应聚合、令牌验证、缓存和负载均衡。在本文中，我们将使用Ocelot C#和YARP .NET等现代工具，实际动手实现一个.NET API网关。

什么是API网关，微服务为什么需要它？

API网关是客户端与后端服务之间的中间层。它像一个“调度员”：接收传入的HTTP请求，分析它们，并将其转发到相应的C#微服务。同时，网关还可以执行其他任务：

\n
• 请求路由——根据URL、标头或参数将请求定向到不同的服务。
\n
• 数据聚合——从多个服务收集响应，并将统一的JSON返回给客户端。
\n
• API网关认证——在请求到达服务之前验证JWT令牌或API密钥。
\n
• 负载均衡——在同一个服务的多个实例之间分配请求。
\n
• 缓存——临时存储频繁请求的数据的响应。
\n
• 速率限制——限制来自单个客户端的请求数量。
\n

没有.NET API网关，每个客户端都必须了解整个系统的架构。有了它，客户端只需与一个端点通信，其余一切都在“幕后”完成。

用于C# API网关的两个主要工具

在.NET生态系统中，有两个强大的解决方案值得你关注：

Ocelot C#

可以说，这是最流行的面向C#服务的API网关。Ocelot是一个开源库，它为任何ASP.NET Core应用程序添加了网关功能。它支持：

\n
• 基于JSON配置的路由
\n
• 响应聚合
\n
• 身份验证和授权
\n
• 速率限制
\n
• 负载均衡（轮询、最少连接）
\n
• WebSocket
\n

YARP .NET（Yet Another Reverse Proxy）

微软的一个项目，定位为高性能反向代理。YARP更灵活、性能更高，但需要更多手动配置。如果你需要对每个请求进行完全控制，它非常合适。

在本文中，我们将重点介绍Ocelot——它更易于上手，并且能覆盖90%的常见任务。

使用Ocelot创建C# API网关：分步指南

让我们编写实际代码。我们将创建一个.NET API网关，它将请求路由到两个微服务：UserService（端口5001）和OrderService（端口5002）。

步骤1：创建项目

打开终端并执行：

dotnet new webapi -n ApiGatewayDemo\ncd ApiGatewayDemo

安装Ocelot包：

dotnet add package Ocelot

步骤2：配置路由规则

在项目根目录下创建ocelot.json文件。在其中描述路由规则：

{\n  "Routes": [\n    {\n      "DownstreamPathTemplate": "/api/users/{everything}",\n      "DownstreamScheme": "http",\n      "DownstreamHostAndPorts": [\n