从OpenAPI的`oneOf`关键字生成的不需要的流/类型脚本类型。有没有另一种OpenAPI模式会有更好的结果？
从OpenAPI的oneOf关键字生成的不需要的流/类型脚本类型，指的是在使用OpenAPI规范定义API时，使用了oneOf关键字来表示多个可能的响应类型，但实际上只需要其中一种类型的情况。
在这种情况下，可以考虑使用anyOf关键字来替代oneOf，以获得更好的结果。anyOf关键字表示多个可能的响应类型中的任意一种都可以满足需求，相比之下，oneOf关键字要求只能有一个响应类型满足需求。
使用anyOf关键字可以简化代码和类型定义，避免生成不需要的流/类型脚本类型。同时，anyOf关键字也更符合实际需求，因为在某些情况下，多个响应类型可能都是有效的。
以下是使用anyOf关键字的示例：
responses:
'200':
description: Success response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ResponseType1'
- $ref: '#/components/schemas/ResponseType2'在上述示例中，使用了anyOf关键字来表示响应类型可以是ResponseType1或ResponseType2中的任意一种。
推荐的腾讯云相关产品和产品介绍链接地址：
相关·内容
scheme": "bearer", } }
} 我们运行以下命令从上面的模式文件生成流类型我们希望它被定义为： export type Item = ChildCategoryResponse | AliasCategoryResponse | SubheaderResponse; 我们的Open
浏览 91提问于2021-07-15得票数 4
回答已采纳
假设我有一个OpenAPI swagger.yml文件，它看起来像：info: version: '1.0' properties: type: string
我更喜欢将真相模式的来源保留在我的模式":
浏览 4提问于2022-02-15得票数 3
2回答
我在XSD文件中有一些模型定义，需要从OpenApi定义引用这些模型。手动重塑是不可行的，因为文件太大了，我需要把它放到一个构建系统中，这样如果XSD发生了变化，我就可以为OpenApi重新生成模型/模式。我尝试过并且几乎成功的方法是使用xsd2json，然后使用节点模块json-schema-to-openapi对其进行转换。然而，xsd2json正在放弃一些complexElement型号。例如，在一个模型中使用"$ref": &quo
浏览 34提问于2019-05-07得票数 9
回答已采纳
我正在开发一个具有Angular前端和RESTful Spring Boot后端的应用程序
我发现了一个来自org.openapitools的非常方便的maven插件。通过其代码生成功能，它有助于在我们的API的前端和后端之间强制执行“契约优先”的方法。但是我们的swagger文件在requestBody和responseBody定义中使用了"oneOf“属性。我试着用它来生成Spring代码，但是
浏览 2提问于2020-07-07得票数 15
} "properties": { "oneOf": [{"$ref": "#/definitions/Foo"}, ] }答案的关键是one
浏览 14提问于2016-12-01得票数 35
回答已采纳
1回答
我正在尝试使用OpenAPI和allOf属性创建一个anyOf自动生成的PHP客户端。此外，这些对象也有一个公共的基本对象。在我的示例模式中，Items是一个数组，其中的项可以是ItemOne或ItemTwo类型。这两种类型的项都有自己的属性(分别为itemOneProperty和itemTw
浏览 0提问于2019-08-01得票数 10
回答已采纳
1回答
Swagger/OpenAPI2.0中的Schema对象是否必须具有type属性？
一方面，根据JSON草案4规范，不指定type属性是OK的，这意味着实例可以是任何类型(对象、数组或原语)。另一方面，我看到了很多Swagger模式，它们包含没有type属性的Schema对象，但是包含了properties属性，这表明模式作者希望实例是一个适当的对象(并且不想接受数组或原语作为有效值)。或者type: object意味着properties<
浏览 2提问于2017-11-19得票数 7
回答已采纳
1回答
我使用openapi生成器Gradle插件从开放API模式生成模型文件。使用build.gradle脚本中的这些设置，一切似乎都很正常： openApiGenerate { apis: "false",dateLibrary: "java8", librar
浏览 17提问于2021-04-13得票数 0
回答已采纳
1回答
它比这复杂得多，因为OpenAPI还有更复杂的“关键字”(oneOf，anyOf)以及数组类型，对象/数组/关键字可以相互嵌套。但从根本上说，任何“模式”的OpenAPI规范都可以转换为示例对象，包括自动生成的虚拟示例。上面的内容就会变成这样： firstName: 'Johnbob',
lastName: 'Default exampl
浏览 2提问于2022-07-01得票数 1
回答已采纳
下面是我的最小工作示例:这里有一个Open API模式，它传递一个openapi: 3.0.0 title: Players API example: READY type: string问题是，我希望phase在状态
浏览 33提问于2021-05-24得票数 0
回答已采纳
我正在做一个Spring项目，它允许用户从端点下载CSV文件。
OpenAPI生成器用于代码生成。根据的“返回文件的响应”部分，响应的模式可以定义为带有format: binary的type: string。然后，生成的接口将类似于：CompletableFuture<ResponseEntity<org.springframework.core.io.Resource>>
浏览 75提问于2021-05-19得票数 0
如何使用定义事件驱动的微服务体系结构？对于事件，重要的是记录在不同服务之间传递的事件有效负载，即使它们不是通过HTTP路径访问的。我所看到的一切都是通过HTTP路径基于API的，所以我现在想知道用OpenAPI / Swagger规范实现这个功能吗？
浏览 2提问于2017-09-15得票数 16
回答已采纳
例如，我希望使用Schema/type而不是模式。我的配置： <groupId>org.openapitools</groupId> <configuration>
<inputSpec>${project.basedir}/ta
浏览 20提问于2021-12-11得票数 1
回答已采纳
我正在尝试使用OpenAPI 3从各种模式组件构建一个响应。
几种模式中的一种，根据用户类型的不同而有所不同。- oneOf组件。下面的代码成功地传递了三个不同的OpenAPI linting工具，但是在它构建的
浏览 1提问于2018-12-13得票数 2
回答已采纳
我在Swagger中有一系列的参数像这样 {有没有办法用Swagger来表达这一点？
浏览 5提问于2014-01-15得票数 45
回答已采纳
1回答
由于krakend.json不是发生傲慢的understands.Following错误的类型，所以：是否有其他方法为krakenD生成文档
浏览 5提问于2020-10-15得票数 2
我希望从OpenApiSchema 6中的任何给定Json对象动态生成.Net。我在代码中没有clr类型可以自动生成Swashbuckle使用的Open，并且需要通过编程方式这样做，并且不需要使用单个对象生成器工具。此外，这些Json对象将由其他用户频繁地更改。我的目标是从给定的json有效负载动态创建OpenAPI规范。给出如下所示的随机Json，并使用C#<e
浏览 3提问于2022-10-08得票数 1
我所处的位置：
我能够使用swagger库(如： )从protobuf文件(.proto)生成.proto规范。但是我的需求是OpenAPI3；更具体地说，我想在OpenAPI3中使用oneOf特性，并从proto的oneof特性映射到它。这在OpenAPI2中是不可能的，因为它不允许API具有多类型定义的请求/响应主体，这是通过启用oneOf<
浏览 4提问于2020-04-21得票数 11
我使用来记录应用程序的所有DTO。我在项目中有很多这样的模型，也有很多mongoose模式和模型。另一方面，我不想使用swagger生成工具。我更喜欢自下而上的方法。
干杯
浏览 15提问于2018-12-01得票数 10
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
腾讯会议活动推荐
腾讯云开发者
