数据与“ oneOf”中的任何模式都不匹配

编程问答 2022-08-11

问题描述

将我的api从.netcore2.2升级到3.1，并尝试使用带有--v3开关的autorest来生成此错误

警告：违反架构：数据与以下来源的任何架构都不匹配 'oneOf'

我尝试了是否使用SerializeAsV2

我从the Autorest docs看到此警告是由于受支持的功能引起的。

anyOf，oneOf当前不受支持

在services.AddSwaggerGen我有

            c.ParameterFilter<SwaggerEnumParameterFilter>();
            c.SchemaFilter<SwaggerEnumFilter>();

其中

public void Apply(OpenApiParameter parameter,ParameterFilterContext context)
{
    var type = context.ApiParameterDescription.Type;

    if (type.IsEnum)
        parameter.Extensions.Add("x-ms-enum",new OpenApiObject
        {
            ["name"] = new OpenApiString(type.Name),["modelAsString"] = new OpenApiBoolean(false)
        });
     
}

public class SwaggerEnumFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema model,SchemaFilterContext context)
    {
        if (model == null)
            throw new ArgumentNullException("model");
        if (context == null)
            throw new ArgumentNullException("context");
        if (context.Type.IsEnum)
            model.Extensions.Add(
                "x-ms-enum",new OpenApiObject
                {
                    ["name"] = new OpenApiString(context.Type.Name),["modelAsString"] = new OpenApiBoolean(false)
                }
            );
    }
}

[更新]

升级到Autorest 3.0.6244后，警告已更改为错误，并且错误消息结尾为

post > parameters > 0)

如果我不使用v3开关，则会收到错误消息

FATAL: swagger-document/individual/schema-validator - FAILED
FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.

我在swagger.json中看到参数属性“ name”没有正确生成。这里包含“正文”，而以前包含“信息” 

"/api/FrameLookUp": {
    "post": {
        "tags": [
            "Frame"
        ],"operationId": "FrameLookup","consumes": [
            "application/json-patch+json","application/json","text/json","application/*+json"
        ],"produces": [
            "application/json"
        ],"parameters": [
            {
                "in": "header","name": "Authorization","description": "access token","required": true,"type": "String"
            },{
                "in": "body","name": "body","schema": {
                    "$ref": "#/definitions/FrameRequest"
                }
            }
        ],"responses": {
            "200": {
                "description": "Success","schema": {
                    "$ref": "#/definitions/FrameResponse"
                }
            }
        }
    }
},

控制器是

[Produces("application/json")]
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme)]
[Route("api")]

public class FrameController : MyController
{
    [ProducesResponseType(typeof(FrameResponse),StatusCodes.Status200OK)]
    [HttpPost("FrameLookUp")]
    public IActionResult FrameLookup([FromBody] FrameRequest  info)
    {
        IMyResponse MyFunc(IMyRequest x) => FrameData.FrameLookUp(info);
        return InnerMethod(MyFunc,info);
    }
 }

更新

我也尝试过使用Swashbuckle.AspNetCore.Annotations中的SwaggerParameter

[更新]

我在想，也许我只需要尝试发布1766号发行版

我尝试克隆swashbuckle.aspnetcore存储库，但遇到了this issue

[更新]

我添加了c.GeneratePolymorphicSchemas（）;到AddSwaggerGen选项，但没有帮助。

[更新] 这是第一条错误消息

ERROR: Schema violation: Data does not match any schemas from 'oneOf'
    - https://localhost:44348/api-docs/v1/swagger.json:1951:8 ($.paths["/api/synchronise-management/get-product-images-Ids"].post.parameters)

在swagger.json中调查1951行

line which causes error

在工作中（从dotnet2.2项目生成），json看起来非常相似，但是参数顺序被交换了

working json

我可以看到的另一个区别是参数的生成名称

我从this question看到错误发生在同一位置

[更新] 当我将--debug开关添加到autorest调用时，我得到

/configuration
DEBUG: pipeline-emitter - END
DEBUG: configuration-emitter - END
DEBUG: swagger-document-override/md-override-loader - END
DEBUG: swagger-document/loader - END
DEBUG: swagger-document/individual/transform - START
DEBUG: swagger-document/individual/transform - END
DEBUG: swagger-document/individual/schema-validator - START
ERROR: Schema violation: Data does not match any schemas from 'oneOf'
    - https://localhost:44348/api/v1/swagger.json:1951:8 ($.paths["/api/synchronise-management/get-product-images-Ids"].

[更新]

这是缩小的json 

{
    "swagger": "2.0","info": {
        "title": "myapi API31","description": "ASP.NET Core Web API","version": "v1"
    },"host": "localhost:44348","basePath": "/v1","schemes": [
        "https"
    ],"paths": {
        "/api/Test": {
            "get": {
                "tags": [
                    "Auth"
                ],"operationId": "Test","responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },"/api/RequestToken": {
            "post": {
                "tags": [
                    "Auth"
                ],"operationId": "RequestToken","consumes": [
                    "application/json-patch+json","application/*+json"
                ],"produces": [
                    "application/json"
                ],"parameters": [
                    {
                        "in": "body","schema": {
                            "$ref": "#/definitions/TokenRequest"
                        }
                    }
                ],"responses": {
                    "200": {
                        "description": "Success","schema": {
                            "$ref": "#/definitions/TokenResponse"
                        }
                    }
                }
            }
        },"/api/FrameLookUp": {
            "post": {
                "tags": [
                    "Frame"
                ],"parameters": [
                    {
                        "in": "header","type": "String"
                    },{
                        "in": "body","schema": {
                            "$ref": "#/definitions/FrameRequest"
                        }
                    }
                ],"schema": {
                            "$ref": "#/definitions/FrameResponse"
                        }
                    }
                }
            }
        } 
    },"definitions": {
        "TokenRequest": {
            "required": [
                "password","username"
            ],"type": "object","properties": {
                "username": {
                    "type": "string"
                },"password": {
                    "type": "string"
                }
            }
        },"TokenResponse": {
            "type": "object","properties": {
                "tokenResult": {
                    "type": "string"
                }
            }
        },"FramePackTypeEnum": {
            "enum": [
                "NotApplicable","PipeRack","LwBVan","VanTray","Car","CarryBag"
            ],"type": "string","x-ms-enum": {
                "name": "FramePackTypeEnum","modelAsString": false
            }
        },"FrameRequest": {
            "type": "object","properties": {
                "qCodeJobId": {
                    "format": "int32","type": "integer"
                },"quantity": {
                    "format": "int32","widthInMm": {
                    "format": "int32","heightInMm": {
                    "format": "int32","ePackingType": {
                    "$ref": "#/definitions/FramePackTypeEnum"
                },"userEmail": {
                    "type": "string"
                }
            }
        },"FrameCaseEnum": {
            "enum": [
                "Case0_NoBraces","Case1_1Vertical_0Horizontal","Case2_2Vertical_0Horizontal","Case3_NVertical_0Horizontal","Case4_0Vertical_1Horizontal","Case5_1Vertical_1Horizontal","Case6_2Vertical_1Horizontal","Case7_NVertical_1Horizontal","Case8_0Vertical_2Horizontal","Case9_1Vertical_2Horizontal","Case10_2Vertical_2Horizontal","Case11_NVertical_2Horizontal","Case12_0Vertical_NHorizontal","Case13_1Vertical_NHorizontal","Case14_2Vertical_NHorizontal","Case15_NVertical_NHorizontal"
            ],"x-ms-enum": {
                "name": "FrameCaseEnum","FrameResponse": {
            "type": "object","properties": {
                "description": {
                    "type": "string"
                },"caseNumber": {
                    "$ref": "#/definitions/FrameCaseEnum"
                },"memberPriceEachExGst": {
                    "format": "double","type": "number"
                },"retailPriceEachExGst": {
                    "format": "double","type": "number"
                }
            }
        }
    }
}

使用.netcore2.2 api，请求生成为

"FrameRequest": {
    "type": "object","properties": {
        "qCodeJobId": {
            "format": "int32","type": "integer"
        },"quantity": {
            "format": "int32","widthInMm": {
            "format": "int32","heightInMm": {
            "format": "int32","ePackingType": {
            "enum": [
                "NotApplicable","userEmail": {
            "type": "string"
        }
    }
}

这是我正在运行的命令行

autorest --input-file=.\myswagger.json --output-folder=generated --csharp --namespace=DDD --debug

作者Kirsten Greed在评论中添加了一些链接：

解决方法

从您的swagger.json中，我们可以看到验证显示：
https://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/heldersepu/hs-scripts/master/swagger/63783800_swagger.json 

{
"schemaValidationMessages": [
{
  "level": "error","domain": "validation","keyword": "oneOf","message": "instance failed to match exactly one schema (matched 0 out of 2)","schema": {
    "loadingURI": "http://swagger.io/v2/schema.json#","pointer": "/definitions/parametersList/items"
  },"instance": {
    "pointer": "/paths/~1api~1FrameLookUp/post/parameters/0"
  }
}
]
}

将我们引至您的代码：

type: "String"应该是：type: "string"，所有小写字母错误都会消失

autorestswashbuckleswashbuckle.aspnetcore

相关问答

matplotlib报错：AttributeError: module 'backend_interagg' has no attribute 'FigureCanvas'. Did you mean: 'FigureCanvasAgg'?
使用本地python环境可以成功执行 import pandas as pd impor...
gitlab登录失败，报错：This challenge page was accidentally cached by an intermediary and is no longer available.
设置时间 控制面板
后端开发常见错误
错误1：Request method ‘DELETE‘ not supported 错误还原：...
docker常见错误
错误1：启动docker镜像时报错：Error response from daemon:...
idea常见错误
错误1：private field ‘xxx‘ is never assigned 按Alt...
pip安装依赖失败
报错如下，通过源不能下载，最后警告pip需升级版本 Requirem...