问题标签 [openapi-generator]

我想将一个 open-api 3.0 yaml 文件导入邮递员 v. 7.1.1。

我正在使用 darkaonline/l5-swagger 在 Laravel 中生成 OpenApi 3.0 文档。生成的 open-api 3.0 yaml 文件在粘贴到 editor.swagger.io 时会产生无错输出。api 是根据 json:api 规范编写的（或打算这样做）。当文件被导入邮递员（v 7.1.1）时，会产生这个错误：“导入Open API 3.0时出错：无法导入”我读过的所有文档都说邮递员现在支持open api 3.0。我尝试从 Zircote 的 github 加载 OpenApi 3.0 yaml 示例，并且它们导入得很好。不过，它们比我们的文档要简单得多。代码摘录：警告这很多，但我觉得我需要提供足够的上下文（它实际上是完整文档的一小部分——文件长 2000 行）：

我有一个用 C++/Qt 编写的 REST 服务。我想创建 REST API 文档（使用 Postman 等 Open API 应用程序）以帮助前端开发人员创建基于 Vue.js 的富客户端应用程序。是否可以使用 JSON 提要（某些 REST 方法的输出）最大限度地减少工作量？

我正在使用 OpenApi3 来定义我的 API，并使用https://mvnrepository.com/artifact/org.openapitools/openapi-generator-gradle-plugin从 api 定义中生成 spring REST 控制器和模型。

我想要一个将可选请求正文作为 JSON 的端点。一个简化的例子：

根据https://swagger.io/docs/specification/describing-request-body/，

默认情况下，请求正文是可选的

我仍然投入了额外的精力required: false来尝试使这个请求正文成为可选的（徒劳的）。尝试在没有请求正文的情况下调用此端点会导致：

这是因为生成器将 bazuu 参数创建为@Valid @RequestBody InlineObject11 inlineObject11. 如果我手动将 RequestBody-annotation 更改为 required=false，我的端点也会接受没有正文的请求。

手动更正一个：

和包装类

我们在 Spring Boot 中使用 OpenAPI 和 openapi-generator-maven-plugin。我们正在尝试在我们的响应中创建一个示例对象。我们遵循了许多不同网页的建议，尤其是这个：

https://swagger.io/docs/specification/adding-examples/

但是无论我们尝试什么，我们要么无法显示示例数据，要么它给我们一个编译错误。

例如，这似乎是我们应该使用的，从我们看到的文档中：

但这会在生成的 API 代码中导致编译错误：

上面的代码中转义字符太多，不应该有双重转义。

这是来自我们 POM 的插件配置：

我们尝试了所有不同的引用和缩进组合，但无济于事。请帮助我们！

我有一个使用 openapi-generator-maven-plugin 版本 4.0.0 和 springfox-swagger2 2.9.2 的项目。所有 java 代码都是从这个插件生成的，基于 3.0.2 openapi yaml 文件。

我的问题是，当我在捆绑的 tomcat 服务器中构建 springboot 项目时，swagger-ui.html 显示了一个额外生成的端点 echo-api-controller，我没有在我的 yaml 中声明：

我搜索了 2 天的版本兼容性解决方案，试图覆盖 Application.java 中的文档，或者修改 yaml 文件但这个额外的端点不会离开。

编辑：代码片段即将推出

是否有将 OpenAPI 3.0 转换为 Swagger 2.0 的生成器？

Mashery 是一个 API 网关，需要 Swagger 2.0 格式的输入才能打开端点。

b) 生成 .NET C# 服务器存根后，文档对如何使用它不是很详细：

您需要自己实现逻辑来处理 API 需要做的任何工作。实施准备就绪后，您可以在本地或服务器上部署 API。请参阅下载存档中的 README.md 文件以开始使用。

有没有关于如何使用代码的教程？我想使用继承来避免生成代码的代码更改。但是文档只讨论了忽略一些生成的文件。大摇大摆的支持告诉我只需“迁移”每次更改时的更改。有什么可能，但我希望能够保持生成的文件不变。我在这里错了吗，这没有特别的需要吗？我想在持续集成环境中使用服务器存根。

我的合同描述符中有以下模型

这会产生

是否有可能以某种方式配置 openapi 生成器来使用@Max而不是@Size进行长度检查？

我使用这个 Maven 插件来生成 DTO

我有一个打开的 api yaml 文件，如下所示。我想将空字符串值作为默认值分配给字符串类型属性。这样做的方法是什么

我定义了 OpenAPI 3.0 文档并使用 openapi-generator-cli-3.3.4.jar 生成 Java 代码 (DTO)。但我无法解决这种情况：List<Map<Integer, Set<String>>>.

1. 有Map<Integer, String>问题：

   • 据我所知，我可以使用模式对象： additionalProperties定义地图类型。

   • OpenAPI 规范附加属性：值可以是布尔值或对象。内联或引用模式必须是模式对象，而不是标准 JSON 模式。

   • 根据上面，我不能将 Map 键设置为整数，对吗？对这个问题有什么建议吗？

2. 在set<String>或set<List<String>>问题：我必须尝试一些努力：

测试1：设置“ uniqueItems ”：真

生成 Java DTO : not Set is List

Testing2 : 将属性测试类型编辑为 Set

警告

生成 Java DTO：有语法错误

Testing3 : 编辑要设置的属性测试类型

警告

生成 Java DTO：有 java Set 类型但不知道设置泛型

• 有什么建议可以修复Map<Integer, String>和在 openapi-generator 中设置 Java 通用问题吗？