如何将Ocelot API Gateway作为出站网关实现外部调用？

下面是完整的C# .NET Core实现步骤，包含Ocelot网关配置和微服务调用代码：

1. 配置Ocelot网关的出站路由 #

在Ocelot项目的ocelot.json配置文件中，添加一条专门用于转发第三方API请求的路由。假设第三方API的GET接口地址为https://api.example.com/public/data，我们让微服务通过Ocelot的/api/thirdparty/public-data路径转发请求：

{
  "Routes": [
    // 保留原有的入站路由配置...
    {
      "UpstreamPathTemplate": "/api/thirdparty/public-data",
      "UpstreamHttpMethod": ["Get"],
      "DownstreamScheme": "https",
      "DownstreamPathTemplate": "/public/data",
      "DownstreamHostAndPorts": [
        {
          "Host": "api.example.com",
          "Port": 443
        }
      ]
    }
  ],
  "GlobalConfiguration": {
    // 保留你的全局配置...
  }
}

• UpstreamPathTemplate：微服务发起请求时指向Ocelot的路径
• DownstreamScheme/HostAndPorts/PathTemplate：组合起来就是第三方API的完整地址
• UpstreamHttpMethod：限定只接受GET请求，和第三方接口匹配

2. 微服务中通过Ocelot发起请求 #

在你的微服务（比如微服务2）中，使用HttpClient调用Ocelot网关的上游路径，而非直接请求第三方API。

方式1：使用IHttpClientFactory（推荐） #

在微服务的Program.cs中注册HttpClient：

var builder = WebApplication.CreateBuilder(args);

// 注册指向Ocelot网关的HttpClient
builder.Services.AddHttpClient("OcelotGatewayClient", client =>
{
    client.BaseAddress = new Uri("http://your-ocelot-gateway-address:port");
    // 示例：http://localhost:5000（Ocelot网关的运行地址）
});

// 其他服务注册...

在需要调用第三方API的服务或控制器中注入IHttpClientFactory并发起请求：

public class ThirdPartyDataService
{
    private readonly IHttpClientFactory _httpClientFactory;

    public ThirdPartyDataService(IHttpClientFactory httpClientFactory)
    {
        _httpClientFactory = httpClientFactory;
    }

    public async Task<string> FetchThirdPartyDataAsync()
    {
        var client = _httpClientFactory.CreateClient("OcelotGatewayClient");
        var response = await client.GetAsync("/api/thirdparty/public-data");
        
        // 确保请求成功，失败则抛出异常
        response.EnsureSuccessStatusCode();
        
        return await response.Content.ReadAsStringAsync();
    }
}

方式2：直接注入HttpClient #

如果是在控制器中使用，也可以直接注入HttpClient：

[ApiController]
[Route("api/[controller]")]
public class DataController : ControllerBase
{
    private readonly HttpClient _ocelotClient;

    public DataController(HttpClient httpClient)
    {
        _ocelotClient = httpClient;
        _ocelotClient.BaseAddress = new Uri("http://your-ocelot-gateway-address:port");
    }

    [HttpGet("third-party")]
    public async Task<IActionResult> GetThirdPartyData()
    {
        var response = await _ocelotClient.GetAsync("/api/thirdparty/public-data");
        
        if (!response.IsSuccessStatusCode)
        {
            return StatusCode((int)response.StatusCode, await response.Content.ReadAsStringAsync());
        }
        
        var data = await response.Content.ReadAsStringAsync();
        return Ok(data);
    }
}

3. 可选：添加认证/请求头转换 #

如果第三方API需要携带特定请求头或认证信息，可以在Ocelot路由配置中添加转换规则：

{
  // 原有路由字段...
  "TransformHeaders": {
    "X-API-Key": "your-third-party-api-key"
  },
  // 如果需要OAuth2认证，添加以下配置
  "AuthenticationOptions": {
    "AuthenticationProviderKey": "Bearer",
    "AllowedScopes": []
  }
}

内容的提问来源于stack exchange，提问作者Markus