问题标签 [swagger-codegen]

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 投票
2 回答
10069 浏览

c# - 自定义生成的模型名称 - Swagger UI

我正在尝试调整自动生成的 Swagger 定义中使用的模型的“displayName”。

这只会影响 Swagger 名称,这意味着代码中的命名空间将保持不变,而从 Swagger UI 查看模型时,您会看到一个自定义名称。

目前,从代码返回的模型名称是一个命名空间,看起来像这样:b.c.d.e.f,我想在代码中添加一个属性并“屏蔽”Swagger 文档的名称,以便在生成文档/Swagger 定义时它会显示为CustomSwaggerName

我有一些 API (C#) 使用包括Swashbuckle(preferred) 和在内的工具SwaggerGen,但现在,如果可能的话,我只想让它在其中任何一个中工作。

我尝试使用看起来正确的属性:

没有运气。我还浏览了SwashBuckle git repo,希望能找到一些东西。

一张应该有助于进一步解释我想要达到的目标的图像。 在此处输入图像描述

我知道这可能看起来像一个奇怪的用例,但它是为我们的 AWS API Gateway 自动化编写的工具,它将使用 Swagger 定义进行一些比较。

0 投票
2 回答
4096 浏览

angular - 在 Windows 操作系统上通过 npm 安装 swagger-codegen

我已经 通过 Java 命令使用https://github.com/swagger-api/swagger-codegen生成了我的客户端 typescript/angular2 语言。

但我想使用 npm 命令而不是 java 命令生成我的客户端 typescript/angular2。

例子 :

我正在使用 Windows 8.1 操作系统。我没有找到要使用 npm 安装的 swagger-codegen 命令。

0 投票
1 回答
114 浏览

typescript - 从 tsd 导出打字稿

文件index.ts (使用 swagger-codegen 生成)


文件tsd.d.ts


typescript 2.2.1.

为什么我仍然需要import myDTO from 'path/to/file/myDTO'在我的文件中使用导入语句( ) ts?我错过了一个概念,应该声明一个模块吗?

0 投票
0 回答
526 浏览

asp.net - 使用 Swagger Codegen 将文件生成到多个路径?

我正在为我们的服务器端代码生成实现创建一个模板,但我遇到了一个功能请求问题......

打算使用生成的基础的开发人员需要以下模式(生成器基于 dotnetcore):

  • 控制器
    • v{api版本}
      • {endpoint}ApiController : 控制器,I{endpoint}Api
  • 接口
    • v{api版本}
      • 我{端点}API
      • I{endpoint}DataProvider
  • DataProviders -v{apiVersion} -{endpoint}DataProvider : I{endpoint}DataProvider

两个接口是相同的,描述端点。DataProvider 实现将允许我们使用 DI 在运行时热交换实际的数据提供者/业务逻辑层。

生成的 ApiControllers 将引用 IDataProviders,并使用实际的实现(即当前活动的)。为此,我们将使用 dotnetcore 的内置依赖注入系统。

但是,我似乎无法找到一种方法来根据模板将操作生成器输出到三个不同的文件夹。它最终会在一个文件夹中混乱,我需要手动移动它们。

有没有办法解决这些要求,还是我应该一直手动解决?

0 投票
1 回答
1284 浏览

java - 无法使用 java 客户端连接到服务器存根

我最近加入了一个项目。我是初学者。我的职责是创建服务器存根、创建 SDK 并使用 SDK 创建一个 java 客户端并与服务器存根通信。

我使用创建服务器存根,

使用它运行它,

网址是,

使用生成的 SDK,

然后我编译了 SDk 并将 .jar 文件导入到我的客户端项目中,这是代码,

我仍在尝试连接到服务器存根,

这是错误,

这里的调用地址与我的服务器存根地址不同。我怎样才能改变它?(我到处搜索,我在代码中找不到这样的地址localhost/0:0:0:0:0:0:0:1:8080

PLzz帮帮我。谢谢

0 投票
3 回答
9803 浏览

spring-boot - 如何自定义 swagger codegen 以生成忽略空值的模型

我正在使用 swagger-codgen 为我的 spring boot 应用程序生成 java 模型类并将它们序列化为 json。默认情况下,这些模型都将包含具有空值的可选属性。

我想为 spring 配置 swagger-codgen 以在所有类之上包含此注释:@JsonInclude(Include.NON_NULL)以便空值属性不包含在序列化的 json 中。

我怎样才能做到这一点?有配置选项还是我必须手动扩展spring codegen?

0 投票
1 回答
1526 浏览

java - 为什么 swagger 会在客户端 SDK 中为 GET 请求生成 void 方法?

  1. 我使用 swagger codegen 在 Java 中生成客户端 SDK。
  2. 例如:

    java -jar swagger-codegen-cli-2.2.1.jar generate -i http://weburl/apidocs/swagger.json -l java -o output

  3. 在生成的文件中有一个ModelAPI.java,其中方法(对应HTTP GET请求)返回void。

  4. 我希望返回 POJO 对象(对应于响应的 json),但返回的是 void。

  5. 有没有办法生成 POJO 对象,这样当我在代码中使用客户端 SDK 时,就可以使用 POJO 对象了?

我错过了什么吗?

0 投票
1 回答
8527 浏览

java - Java REST 客户端的 swagger-codegen 标头参数

我正在使用 swagger-codegen 为我的一个 REST API 生成 Java REST 客户端。REST API 采用可选的标头参数。客户端中生成的方法有一个带有标头的附加参数。我希望在方法签名中没有标头参数的情况下生成方法。我已阅读文档,但找不到任何参考。

例如,对于带有选项 X-CUSTOM-HEADER 参数的 GET all API,swagger-codegen 会生成如下所示的方法:

我希望它在哪里:

寻找解决方法的指针,而不是自定义客户端代码生成。

编辑 1:添加 JSON 规范

0 投票
1 回答
1690 浏览

java - 如何在swagger codegen中设置方法名称前缀?

(招摇的新手)

在 swagger 规范文件中, operationId 是操作的名称,对应 HTTP 方法。

例如,

如上所示, operationId = findPetsByStatus。假设我想为我的 java 代码中的所有 get 操作生成一个前缀,前缀 = 'get_'。

例如,我希望 swagger codegen 生成与前缀 = 'get_' 的 HTTP GET 方法相对应的所有操作。具体来说,在上面,它可能会生成:get_findPetsByStatus。

有没有办法告诉招摇代码生成前缀方法?

请注意,我想使用 swagger-codegen 本身,而不是类似 APIMatic 的替代品。

0 投票
0 回答
7380 浏览

java - 未能执行目标 org.apache.maven.plugins:maven-compiler-plugin:3.1:compile swagger-codegen-plugin

我正在尝试使用swagger-codegen-maven-plugin生成文档

但我得到一个错误。我的 pom 是

当我使用mvn clean compile一些客户端代码时生成但有错误生成。

java版本是1.8.0_25。我怎样才能解决这个问题?请帮忙。谢谢