问题标签 [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 投票
4 回答
13757 浏览

sdk - 有人在生产中使用 Swagger Codegen 或 OpenAPI Generator SDK吗?

Swagger 代码生成器可以生成多种语言的 SDK(下面从 Github 项目页面列出)。是否有人在生产中使用任何 Swagger 自动生成的 SDK,包括 alpha/beta 版和 GA 版,如果是,哪些组织和哪些语言?

我做了一些谷歌搜索并四处询问。虽然我发现了许多部署 Swagger UI 的示例,但我还没有找到任何 Code Gen SDK。

项目页面:https ://github.com/swagger-api/swagger-codegen

语言:

更新 - 重大项目官方 SDK 跟踪(2018 年 6 月)

我在这里跟踪来自较大组织的可识别的官方代码生成 SDK,以更好地跟踪采用情况。许多将自己列为使用某些代码生成项目的组织尚未在其 GitHub 帐户上发布 SDK。

更新 - 个人经历(2017 年 12 月)

我现在一直在积极地使用 Swagger Codegen for Go (2.2.3 - 2.3.1)。到目前为止,我的经验是它做得不错,但可能需要进行各种手动调整才能获得有效的 SDK,因此 GitHub 包/repo 仍然不错。您可以在我维护的 SDK 的 GitHub 问题中看到一些问题。codegen/swagger_codegen_command.sh我还在每个 repo中的文件中添加了后期处理。

更新 - 添加 OpenAPI 生成器(2018 年 7 月)

OpenAPI Generator 是 Swagger Codegen 的一个分支,所以现在也提到了这一点。

0 投票
4 回答
8280 浏览

swagger - 是否有任何支持 OpenAPI 3 的生成器?

在撰写本文时,OpenAPI 3 规范相对较新。我正在努力寻找任何支持 3.0 版的文档生成器。

有谁知道支持 OpenAPI v3.0 的生成器?

0 投票
2 回答
5165 浏览

asp.net-core - 如何从 OpenAPI 3.0 架构生成 ASP.NET Core 2 控制器?

我有一个 OpenAPI 3.0 架构 YAML 文档,它定义了一些包含所有必需参数和响应的 API 端点。

现在,我想生成一些样板的服务器端代码:控制器及其方法。我的 API 将使用 ASP.NET Core 2 编写。那么,是否可以使用某种生成器,还是应该手动执行?

PS我知道我可以生成客户端代码,但我现在不需要它......

0 投票
2 回答
64899 浏览

maven - 适用于 OpenAPI 3.0 的 Swagger Codegen(带有 maven 插件)

我想为 OpenAPI 3.0 YAML 文件使用 Swagger Codegen。而且我看到Swagger Codegen 3.0.0-rc0可用。但是当我尝试使用它时,我遇到了问题。以下是详细信息:

我的pom.xml文件带有 swagger-codegen 插件:

当我运行 maven 构建时,使用上面的插件,我得到了这个ServiceConfigurationError,这是堆栈跟踪:

为了解决这个问题,我在 pom 文件的 maven 插件部分添加了swagger-codegen-generators依赖项:

因此,前面提到的这个问题得到了解决,但现在我看到了这个 NPE

正如您已经注意到的那样,我正在使用<language>spring</language>and <library>spring-mvc</library>。请让我知道 codegen 是否适用于具有这些配置的 3.0.0-rc0 的某人。

注意:我查看了这个类似的旧帖子3.0.0-rc0,但当时不可用。

0 投票
1 回答
631 浏览

java - OpenAPI Generator / Swagger Codegen:生成所有文件后如何添加函数

在 Go 客户端生成器创建所有文件之后,我正在尝试添加一个钩子,我想知道在哪里可以添加它。

现在,文件按以下顺序生成 (a) 模型 (b) API 路径 (c) 支持文件。

如果我像这样钩入AbstractGoCodegen'spostProcessSupportingFileData函数,将myfunc()在创建支持文件之前调用,但我希望之后调用该函数。README.mdclient.go

我还尝试了其他一些postProcessing*功能,如图所示,DefaultCodegen但它们没有按预期工作。

我怎样才能做到这一点?

0 投票
1 回答
848 浏览

python - Django Rest Framework 是否有第三方应用程序可以自动生成 swagger.yaml 文件?

我有大量的 API 端点被写入django-rest-framework并且它不断增加和更新。如何创建和维护应该是最新的 API 文档?

我目前的版本是

  1. 创建swagger.yaml文件并以某种方式在每次任何端点更改时自动生成。
  2. 然后将此文件用作 readme.io、ReDoc 或其他替代方案的输入,以向外部人员提供可视化。

如果您对此或任何类似解决方案有经验,请分享我非常感谢!

0 投票
0 回答
1222 浏览

rest - OpenAPI 客户端生成器组合多个文件和项目

我正在使用 OpenAPI 生成器 ( https://github.com/OpenAPITools/openapi-generator ) 来生成 C# 客户端。

我有两个 C# 项目(OpenAPITools 和 OpenAPITools.Test) -

在此处输入图像描述

现在使用下面的命令,创建了一个 .sln 和两个项目 -

  1. 有没有办法只创建一个包含两个当前项目内容的项目?

  2. 我有多个 Open API 规范,我希望它们都属于一个解决方案(每个规范都可以有自己的项目)。那可能吗?

0 投票
1 回答
1633 浏览

swagger - 模型中 List 的 Swagger 2.0 默认 null

我正在尝试构建一个模型对象,其中包含一个“字符串列表”键值对。有没有办法将列表默认为 null 而不是空列表?

目前这是模型的设置方式:

当该or字段为空时,它只会生成一个空列表or: [],有没有办法生成or: null而不是or: []

0 投票
1 回答
223 浏览

open-liberty - 合约优先 OpenAPI 生成

我尝试使用一个简单的 OpenAPI V3 API 在 OpenLiberty 上实现合同优先范式。

我使用以下插件生成 OpenAPI 代码:

对于我使用的一代<generatorName>jaxrs-spec</generatorName>

<configOptions>我使用<useSwaggerAnnotations>false</useSwaggerAnnotations>

除了模型类之外,还会生成以下接口:

我尝试像这样尽可能精简地使用我的实现:

我可以使用以下 curl 命令调用 curl -X GET "http://localhost:9080/properties-sample/systems" 这行得通!

但是我本来希望使用以下内容 curl -X GET "http://localhost:9080/properties-sample/inventory/systems" ,但这不起作用。我必须将 Impl 中的 @Path 更改为@Path("/inventory"),因此它可以使用curl -X GET "http://localhost:9080/properties-sample/inventory/systems"

这是按设计工作还是@Path界面上的注释无关?

其他人是否有另一种在 OpenLiberty 中使用合同第一范式的方法?

0 投票
2 回答
666 浏览

angular - 如何使用 Swagger 生成 UI

我正在使用 SWAGGER 生成 android 和 angular 客户端。Swagger 只生成服务和模型,swagger 是否也生成 Angular.ts组件.html forms templates?如果没有,这里有没有人知道另一个生成器或工具?

还是我必须自己编码?