Ocelot网关配置后Swagger未显示添加的端点问题

我正在使用Ocelot作为微服务网关，希望通过Swagger查看可用端点。已按步骤完成配置，但端点未显示在Swagger UI中。测试时网关可正常转发请求到正确端点，但Swagger里无对应内容。

我的Ocelot配置文件 #

{
  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:5001"
  },
  "Routes": [
    {
      "UpstreamPathTemplate": "/users",
      "UpstreamHttpMethod": ["GET"],
      "DownstreamPathTemplate": "/WeatherForecast/users",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5002
        }
      ],
      "SwaggerKey": "users"
    }
  ],
  "SwaggerEndPoints": [
    {
      "Key": "users",
      "Config": [
        {
          "Name": "API Client",
          "Version": "v1",
          "Url": "http://localhost:5002/swagger/v1/swagger.json"
        }
      ]
    }
  ]
}

Swagger UI截图 #

排查与解决步骤 #

• 验证下游Swagger文档可达性
  直接访问http://localhost:5002/swagger/v1/swagger.json，确认能正常返回JSON格式的Swagger文档。若无法访问，先排查下游服务的Swagger配置：是否启用Swagger中间件、路由是否正确、服务是否正常运行。

• 核对路径映射与下游端点一致性
  路由中DownstreamPathTemplate为/WeatherForecast/users，需确保下游服务的Swagger文档中确实存在该路径的端点。如果下游Swagger里的端点路径是/users而非/WeatherForecast/users，Ocelot无法匹配对应条目，导致Swagger不显示。

• 检查网关Swagger中间件配置
  确保网关项目正确集成Ocelot与Swagger：

  1. 安装Ocelot.Swagger NuGet包
  2. 在Program.cs中按顺序配置中间件：

     builder.Services.AddSwaggerForOcelot(builder.Configuration);
     
     // ...
     
     app.UseSwagger();
     app.UseSwaggerUI(options =>
     {
         options.SwaggerEndpoint("/swagger/v1/swagger.json", "Gateway API");
     });
     app.UseOcelot().Wait();
     

  注意：UseSwagger、UseSwaggerUI必须在UseOcelot之前注册。

• 确认SwaggerKey完全匹配
  路由配置的SwaggerKey: "users"需与SwaggerEndPoints中的Key: "users"完全一致（大小写敏感）。

• 检查BaseUrl配置准确性
  确认GlobalConfiguration.BaseUrl与网关实际运行地址一致，若网关运行端口不是5001，需修改该配置。

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