如何在OpenApi中使用具有两个相似模式的OneOf？
在OpenAPI中，可以使用OneOf关键字来定义具有两个相似模式的接口。OneOf关键字用于指定一个属性可以匹配多个不同的模式之一。在OpenAPI规范中，可以使用OneOf关键字来解决接口设计中的多态性需求。
使用OneOf关键字的基本语法如下：
components:
schemas:
MyResponse:
oneOf:
- $ref: '#/components/schemas/SuccessResponse'
- $ref: '#/components/schemas/ErrorResponse'在上述示例中，MyResponse是一个具有两个相似模式的接口，可以是SuccessResponse或ErrorResponse中的任意一种。通过使用$ref关键字，可以将具体的模式定义放在组件schemas中进行引用。
OneOf关键字的应用场景可以是在某个接口返回结果中，既可以是成功的响应模式，也可以是错误的响应模式，用于区分不同的返回结果。
在腾讯云的相关产品中，腾讯云API网关可以帮助开发者更好地管理和发布OpenAPI接口。腾讯云API网关提供了丰富的功能，包括接口发布、安全认证、请求转发、流量控制等，可以满足开发者在云计算领域的各种需求。具体的产品介绍和文档可以参考腾讯云API网关的官方文档链接：腾讯云API网关。
相关·内容
我在openapi中有以下模式 /submit: description: Submit info operationIddescription: submitted successfully application/json: oneOf尽管我在FooResponse和BarResponse中有不同<
浏览 22提问于2021-01-12得票数 0
2回答
我如何指出在my_object中您可以使用property_1或property_2，但不能两者兼得？ type: object property_1: property_2:
浏览 0提问于2019-04-10得票数 4
回答已采纳
我有一个场景，我的ASP.NET WEB API根据请求对象返回2个不同的模型。我正在使用swagger UI (通过swashbuckle)来记录我的ASP.NET WEB API，但目前无法找到一种方法来记录这两个模型和1个ASP.NET WEB API操作。我试过用谷歌搜索，但收效甚微。任何帮助都将不胜感激。
浏览 2提问于2017-08-22得票数 0
回答已采纳
我需要为搜索API定义swagger/OpenAPI v3.0文件。我的请求可以指定地理空间坐标(经度和纬度)或(邮政编码和国家代码)或(城市、州和国家代码)。除此之外，我还有两个强制性属性，如distanceUnits.和#en0#。我知道如何在JSON模式中实现它 "postalCode": ["countryCode"],
浏览 8提问于2021-09-13得票数 1
回答已采纳
} "properties": { "oneOf": [{"$ref": "#/definitions/Foo"}, ] }答案的关键是one
浏览 14提问于2016-12-01得票数 35
回答已采纳
我试图使用实现在Swagger或OpenAPI 3.0中定义的API。具体的模型可以增加额外的字段。好的，很烦人，但解决方法可能是用OpenAPI 3.0定义API，并在模式中使用oneOf： /pets: requestBody:
浏览 1提问于2019-11-18得票数 6
这个问题不是()的重复，因为该OP试图返回200或400。GET /endpoint -> {200, schema_1}在yaml中，我尝试有两个200代码，但查看器将它们压缩，就像我只指定了一个一样。
有没有
浏览 0提问于2016-04-12得票数 46
回答已采纳
1回答
我为我的web应用程序提供了以下json模式。"type":"object", "person_identifier":{ "oneOf我无法验证上面的模式是否会强制执行所需的约束。我尝试过在jsfiddle.com上进行验证，但它显示我的<em
浏览 2提问于2014-05-31得票数 1
我正在尝试使用OpenAPI 3从各种模式组件构建一个响应。
几种模式中的一种，根据用户类型的不同而有所不同。- oneOf组件。下面的代码成功地传递了三个不同的OpenAPI linting工具，但是在它构建的示例中，Swagger没有显示项目2
浏览 1提问于2018-12-13得票数 2
回答已采纳
我有一个示例SpringBoot API，它具有以下特性：2.2.6org.springdoc:springdoc-openapi-ui:1.4.1org.springdoc:springdoc-openapi</e
浏览 14提问于2020-06-29得票数 4
回答已采纳
2回答
在有关参数序列化的OpenAPI文档中，有一个关于如何序列化具有不同样式的查询、路径、头和cookie参数的简短章节。这些参数的模式被描述为OpenAPI风格的json模式，它允许无限嵌套对象和数组。关于如何在文档中处理这些问题，我还没有发现任何提及：
{
"type": "ob
浏览 10提问于2021-05-28得票数 2
回答已采纳
如果我试图引用这两个文件，如：# ther OpenAPI def stuffcomponents: { $ref: widgets.a.yamlSwagger工具链抛出一个错误，说明schemas中有一个重复的键，但是这两个widgets.(a|b).yaml文件是互斥的(即没有共享模式缺陷)。有人有关于将大型数据模型组织成多个文件(每个文件都有潜在的多个JSON模式)<em
浏览 4提问于2020-11-21得票数 1
我们的一个API接受来自用户的证书。按照当前的设计，用户在有效负载中转储原始证书数据，并发出内容类型设置为application/x-pkcs12.的POST请求。因此，从本质上说，我们的API是接受请求正文中文件的原始字节。
如果我试图通过Swagger定义这个API，那么我就不能这么做。因为，如果我错了，那么这个操作的参数必须是'in‘body，而这个参数的’类型‘必须是文件。Swagger要求所有主体参数都必须具有</
浏览 1提问于2015-01-14得票数 0
我最初的用例：我能够使用swagger库(如： )从protobuf文件(.proto)生成.proto规范。但是我的需求是OpenAPI3；更具体地说，我想在Ope
浏览 4提问于2020-04-21得票数 11
5回答
有一些很好的工具可以针对JSON进行验证，但是我没有机会找到一个工具来验证在Swagger (用于创建API模式的工具)中创建的规范。我找到的唯一解决方案是在Swagger中生成一个客户机/服务器，它非常麻烦。
是否已经有了针对Swagger验证JSON的现有工具？
浏览 6提问于2016-09-01得票数 66
回答已采纳
我正在寻找一种优雅的方法来定义一个api，它既可以使用JSON数据，也可以使用表单数据。下面的代码片段可以工作，但它并不优雅，需要后端中所有丑陋的代码。有更好的方法来定义这个吗？现在起作用的： /pets: consumes: - applicationdescription: Updated name of the pet
required:
浏览 3提问于2017-02-17得票数 9
回答已采纳
这是我的计划，但是不能生成到OpenAPI文档的身份验证部分。api_key
async def test_api(req: ReqModel, api_key=Depends(HMACAuth())):
pass 当OpenAPI对象初始化带有分析输出OpenAPI(**output)时，自定义模型似乎会被忽略。(输出中有安全机制，但OpenAPI对象中缺少安全机制)。(参考代码:https:/&#x
浏览 67提问于2020-07-15得票数 3
在包含oneOf关键字结果的openapi 3.3规范上使用openapi-生成器-cli生成golang代码，导致代码损坏和无法编译。给定此架构： "schemas": { "type": "object", "Bar": {
"oneOf，应该会产生interface{}，我会
浏览 89提问于2020-12-03得票数 0
1回答
此特定端点根据匹配的请求参数(如服务级别和包信息)返回单个速率，以选择最佳选项。我们目前支持允许客户在请求时进入运营商，然后它将只从该运营商中选择一个速率。然而，在某些情况下，被请求的承运人不提供匹配的服务，而且业务要求我们现在允许该服务替代被请求的承运人，以替代能够满足请求的另一承运人，但只有在某些情况下。但是，我不确定这是否是正确的方法，因为这不是一个常见的模式，我不知道如何称呼这样一个领域。这些选项中哪一个看起来最正确？
浏览 0提问于2021-01-11得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
云直播
对象存储
腾讯会议活动推荐
腾讯云开发者
