Ocelot Swagger Mmlib.swaggerforocelot显示“规格中定义的无操作！”

Question

我正在使用ocelot网关，并使用“ mmlib.swaggerforocelot ”库来进行摇摇欲坠的文档。 对于一些Swagger键，Swagger UI显示“规格中没有定义的操作！” Swagger Json即将到来，没有诸如

{
  "openapi": "3.0.1",
  "info": {
    "title": "Admin API",
    "version": "v1"
  },
  "paths": {},
  "components": {
    "schemas": {}
  }
}

Ocelot配置路线之类的

{
      "DownstreamPathTemplate": "/api/admin/v{version}/{everything} ",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5000
        }
      ],
      "UpstreamPathTemplate": "/api/admin/v{version}/{everything}",
      "UpstreamHttpMethod": [],
      "QoSOptions": {
        "ExceptionsAllowedBeforeBreaking": 3,
        "DurationOfBreak": 1000,
        "TimeoutValue": 900000
      },
      "SwaggerKey": "AdminAPI"
    }

路径，而Swagger配置

 "SwaggerEndPoints": [
    {
      "Key": "AdminAPI",
      "Config": [
        {
          "Name": "Admin API",
          "Version": "v1",
          "Url": "http://localhost:5000/swagger/v1/swagger.json"
        }
      ]
    }
    
  ]

在审查 mmlib.swaggerforocelot 源代码之后，它看起来与下游路径中的版本有关这可以解决吗？

Answer 1

问题是 mmlib.swaggerforocelot 在执行Ocelot转换时没有考虑{version}。

RouteOptions 具有属性 transformbyocelotconfig 默认设置为TRUE，因此一旦从下游获得Swagger JSON，将进行转换。
在这里，它将尝试从下面的路线配置找到路由，如果找不到的话，它将从Swagger JSON删除路线，

private static RouteOptions FindRoute(IEnumerable<RouteOptions> routes, string downstreamPath, string basePath)
        {
            string downstreamPathWithBasePath = PathHelper.BuildPath(basePath, downstreamPath);
            return routes.FirstOrDefault(p
                => p.CanCatchAll
                    ? downstreamPathWithBasePath.StartsWith(p.DownstreamPathWithSlash, StringComparison.CurrentCultureIgnoreCase)
                    : p.DownstreamPathWithSlash.Equals(downstreamPathWithBasePath, StringComparison.CurrentCultureIgnoreCase));
        }

问题是 startswith 将返回false，因为Swagger JSON路径会

/api/admin/v{version}/Connections

和路线config就是这样

/api/admin/v{version}/{everything}

，并且版本将替换为Swagger选项中给出的版本，以便将其解决

/api/admin/v1/{everything}

此问题的解决方案将

1. 设置为“ transformbyocelotconfig”：swagger in swagger选项

"SwaggerEndPoints": [
    {
      "Key": "AdminAPI",
      "TransformByOcelotConfig":false,
      "Config": [
        {
          "Name": "Admin API",
          "Version": "v1",
          "Url": "http://localhost:5000/swagger/v1/swagger.json"
        }
      ]
    }
    
  ]

2. 或更改路由，只是拥有{questhts}键word

{
      "DownstreamPathTemplate": "/api/admin/{everything} ",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5000
        }
      ],
      "UpstreamPathTemplate": "/api/admin/{everything}",
      "UpstreamHttpMethod": [],
      "QoSOptions": {
        "ExceptionsAllowedBeforeBreaking": 3,
        "DurationOfBreak": 1000,
        "TimeoutValue": 900000
      },
      "SwaggerKey": "AdminAPI"
    }