问题标签 [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 回答
5116 浏览

openapi - 开放 API 生成器的身份验证

如果已经回答了这个问题,我深表歉意,但我找不到明确的答案。

当前的生成器是否支持身份验证?

我需要生成一个具有 2 种潜在身份验证方式的客户端:

  1. 通过 API 密钥,这意味着一个必需的api_token参数。
  2. 通过 OAuth 2 身份验证代码流。

如果是这样,我该如何使用它?

如果没有,您认为在生成客户端后添加身份验证的最佳方法是什么?

0 投票
0 回答
107 浏览

symfony4 - 如何将我的 OpenApi 3.0 导入 Api 平台?(先签约)

我想使用 Api Platform (symfony 4) 来制作 API Rest。在开始使用 API 平台之前,我使用 Api Generator 创建了 Openapi 3.0 (swagger)。所以我先定义合同。

所以现在,我想将我的架构从 Openapi 导入 API 平台,但我不知道我们是否可以这样做。

我知道可以从 API 平台导出到 Openapi(以创建文档),但我认为无法导入。

有人有想法吗?谢谢你的帮助,

0 投票
0 回答
251 浏览

openapi - 如何在 OpenAPI 2.0 规范中添加 content-disposition 标头

我是 OpenAPI 规范的新手,目前正在开发一个使用 OpenAPI 规范 2.0 的项目。我们还使用 swagger-codegen 从这个规范文件生成 REST 接口。

现在,我被困在一个场景中,我必须将 Excel 文件作为输出传递给 REST 调用,因此我需要在 OpenAPI 规范中的此 REST API 的响应标头中提及内容处置,以便自动生成代码也有同样的事情。

有没有办法让我的自动生成的代码自动检测到该标头?

0 投票
0 回答
572 浏览

java - openapi 代码生成器 - 使用 @Digits 代替 @DecimalMax / @DecimalMin

下面是我的字段num1,在精度点之后我总是只需要 2 位数字,所以我在合同中使用了minimummaximum约束。

useBeanValidation在生成代码时启用了选项。因此,上面的 openapi 字段会num1生成BigDecimal java如下所示的映射:

有了这个,我期望10.45是有效的并且10.451是无效的。但是,10.451被视为有效。我理解,逻辑上10.451是有效的,因为它大于minimum值。

我发现@Digits提供了预期的行为,但我需要一些帮助来配置openapi-generator-maven-plugin (v 3.3.1)使用@Digits注释而不是@DecimalMin / @DecimalMax注释。有人遇到过这种问题吗?

以下是我config optionsopenapi-generator-maven-plugin

0 投票
1 回答
430 浏览

java - 使用 OPEN API 生成 2 种具有 2 种不同媒体类型的方法 - Spring Boot

我的 Spring Boot 应用程序中有两种方法,RequestMapping一种返回JSON,另一种返回returns byte[]

我通过OpenApiusing .yamlusing生成接口openapi-generator-cli-3.3.0.jar 当我生成接口时,我的接口生成这样的方法

我怎样才能强制它制作两种单独的方法而不是一种?

0 投票
4 回答
584 浏览

python - openapi 代码生成器 - python 服务器存根工作流程

我正在使用 openapi-generator 生成服务器存根 python 代码。一切正常,但是,每次我对 OpenAPI 规范(yaml 文件)进行更改时,代码生成器都会覆盖整个代码,甚至是定制的代码(控制器)。我想开发一个增量工作流,如果我对规范进行更改,生成器会修改仅处理该部分代码的代码。

如果我能够执行规范并拥有增量工作流程,那就太好了。

我正在使用 openapi-generator 版本 3.3.4。

我试图修改控制器并删除# noqa: E501,但每次我从规范生成存根时,它仍然会覆盖代码。

由于生成的代码不是 OOP,如何通过生成的接口隔离控制器实现?

0 投票
2 回答
2122 浏览

python - 如何从现有的 falcon api 生成 Open API 规范?

我有一个用 Falcon 框架编写的现有 RESTful API。目前,我将 Sphinx 用于 API 文档。我想切换到 Swagger(现在称为 OpenAPI)并自动生成 Swagger 规范。在GG上搜索了一会,找到了一个PyPi包falcon-swagger-ui。但看起来我必须手动编写规范。我想要像 Sphinx 这样的东西,我可以使用一些 Sphinx 模板编写普通的 python 文档字符串。现在我找到了 p2swagger 但不知道如何设置?谁能建议我该怎么做?预先感谢

0 投票
1 回答
2384 浏览

angular - 如何只生成 API 的接口?

我正在尝试仅使用 OpenApi 及其 maven 插件openapi-generator-maven-plugin生成接口,但它也会生成我不想要/不需要的完整服务。

现在我找到了withInterfaces 属性,但是当设置为 true 时,它​​还会生成 API 服务。所以它产生了我想要的东西,但也产生了我不想要的服务。

这是我的 pom 配置:

我想要的是模型、pom 中描述的一些支持文件,以及只有API 接口(不是完整的服务)。

有人知道如何做到这一点吗?

0 投票
1 回答
3330 浏览

openapi-generator - 是否可以在 Openapi 代码生成中排除路径?

我们正在使用具有许多可选功能的大型第三方 API。有 27 个端点,我们只需要来自 Maven 的一些端点。我们正在使用服务器端生成。

如果您有兴趣,API 在这里:https ://github.com/mjeffrey/psd2 理想情况下,我们只会生成和公开我们支持的那些。

是否可以只生成 API 端点列表或排除我们不想支持的端点?

我看到有可能只生成某些模型,但这不是我们需要的。-D apis 参数似乎在源代码中被视为布尔值。

https://github.com/OpenAPITools/openapi-generator#3--- 用法 https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md#selective-generation

我也在考虑一个预处理器,所以我们不需要手动编辑 yaml 文件(定期更新)。对 yaml 文件进行预处理有什么建议吗?

0 投票
0 回答
427 浏览

swagger-codegen - 带有选项 -DsupportingFiles= 的 codegen CLI 多个文件

我正在尝试使用 openapi-generator 生成服务器,我想选择我创建的支持文件。我知道有这个选项-DsupportingFiles=StringUtil.java。这个例子来自这个页面

我的问题很简单,如何选择要生成的文件列表。我成功地一次生成一个文件。在他们谈论 CSV 格式的文档中,我尝试了所有这些选项,但似乎没有任何效果。

任何人都知道这是否可能,或者即使这是正确的方法?