问题标签 [openapi-generator]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
3695 浏览

swagger - 如何使用具有构造函数的开放 api 生成器生成类模型?

我正在使用 openapi-generator 来生成 typescript-fetch。我喜欢使用 openapi-generator,因为它支持 DTO 作为查询参数,如果我有 10 个查询参数,方法会生成为 RequestDto。太棒了,想象一下有 10 个参数并排作为方法输入,噩梦。无论如何,这很好,但是当你像这样使用它时:

java -jar openapi-generator-cli-4.0.3.jar generate -i ../swagger-spec.json -g typescript-fetch -o api-specs --enable-post-process-file --skip-validate-spec

它将生成模型目录,但其中包含接口而不是实际类。我不能说new Interface,手动创建 50 个实现这些接口的类对我来说没有多大意义。

那么,openapi 生成器有什么方法可以生成带有构造函数的模型(类)吗?

Nswag 正在生成实际的类(具有构造函数和接口),但它不会将查询参数转换为 Dto。

0 投票
1 回答
1394 浏览

rest - 我应该在 OpenAPI 中定义不同的 POST 和 PATCH 模型吗?

我在 OpenAPI3 (Swagger) 中定义了一个 REST API。

我有一个 API,它有一个 POST,它使用我在组件部分定义的模型,如下所示:

现在我有一个 PATCH API 调用,我想用它来更新 MyModel 的一些数据,例如 SomeProperty1 和 SomeProperty4。

我应该为此 PATCH 操作定义一个新模型吗?像这样:

然后在 PATCH 操作的 requestBody 中使用这个新的 MyPATCHModel?这里的标准做法是什么,因为我将有几个与此类似的 API。

0 投票
3 回答
9886 浏览

openapi-generator - 如何使用 openAPI Generator 和 Maven 跳过支持和元数据文件的生成?

我正在使用openapi-yaml带有 Maven 的生成器将一个 swagger 文件转换为一个开放的 API v3 文件。

我想做的是将新文件直接放入某个目录中。

但是会生成一些我不需要的附加文件,例如README.md.openapi-generator/VERSION.openapi-generator-ignore

是否可以禁用此行为并仅生成.yaml文件?

0 投票
1 回答
350 浏览

java - OpenAPI 生成器的 Gradle 配置

当使用带有 Gradle 的 OpenAPI 生成器时,我希望将性别化的源发送到其他源生成器插件使用的标准目录。类似于 Maven 生成源。

到目前为止,我还不能这样做,尤其是将生成限制为 Java 源类而不是整个“原型项目”。

似乎 OpenAPI Gradle 插件工作流程与 Maven 工作流程不同。

是否有一个配置标志来省略所有非 java 代码的生成,并在“生成的源”文件夹(例如 /out/production/generated/)中这样做?

0 投票
0 回答
689 浏览

python - Python openapi-generator如何进行http异步调用

我正在使用 python 的 openapi-generator 创建一个自动生成的 API 客户端。这个 API 有一些异步函数返回数据行: JSON 异步。

我想要一个回调来获取这些数据并在单独的线程上处理它。

顺便说一句,在生成的python代码上写着调用函数:

所以似乎以某种方式支持异步调用。

但是没有定义如何使用,例如如果我调用线程:

程序刚刚停止,“应该打印”短语在服务器关闭连接之前永远不会打印,所以不是异步的,所以不是单独的线程。

所以我希望有一种方法来设置回调并以异步方式重现调用。

0 投票
0 回答
188 浏览

jmeter - 如何使 openapi-generator 更改默认 JMeter 变量、CSV 内容?

我正在尝试根据 YAML 中定义的 API 制定 JMeter 测试计划,但我希望能够定义我的默认参数及其值。

有没有办法用我自己的参数、值甚至 CSV 内容生成 *.jmx?例如,我希望我可以在 config(默认情况下不是 localhost)、testCases(实际上是循环编号)甚至我自己的 JMeter 示例中设置我自己的主机。

0 投票
1 回答
568 浏览

spring-boot - 如何创建 Open API 3.0.1 规范

我是 swagger 文档等的新手,请您分享为以下端点创建开放 API 规范的任何好的资源或步骤,该端点是 Spring Boot 微服务的端点:

任何帮助或参考将不胜感激。谢谢大家。

0 投票
1 回答
324 浏览

swagger-codegen - 如何引用 OpenAPI Generator 任务属性

我试图在设置 outputDir 时引用分配的属性 generatorName。

尝试使用与其他任务属性(即 $buildDir)相同的语法来引用 generatorName 属性。还尝试更全面地限定属性名称 openApiGenerator.generatorName。

调试代码的输出显示无法引用 generatorName 属性:

0 投票
1 回答
2249 浏览

spring-mvc - OpenApi 3.0.2 | Spring 服务器生成器 | Api/Controller 接口命名

我正在尝试为 OpenApi 3.0.2 规范锻炼生成的服务器端 Spring MVC 代码。

这就是“路径”之一的样子:-

使用配置为的 Maven 插件生成服务器端代码:-

从插件配置中可以看出,我只对生成模型类和 Spring 控制器接口/API 接口感兴趣。

问题

对于提到的 OpenAPI 规范,生成的 MVC 控制器接口被命名为ApiApi. 我猜这是源自路径的开始部分。我可以摆脱这/api/v1/int部分,但这会生成名为的接口,IntegrationsApi但我不希望它被命名为 say InventoryApi。我们有什么选项来控制生成的控制器界面?

0 投票
0 回答
146 浏览

openapi-generator - 如何使用自定义响应类而不是使用spring默认的ResponseEntity

我正在使用 openapi-generator-maven-plugin 生成类。使用以下依赖项

生成的 java api 具有返回类型org.springframework.http.ResponseEntity


我想使用自定义响应类型,而不是使用默认响应类型。有什么方法可以实现吗?