问题标签 [swagger-maven-plugin]

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 回答
109 浏览

java - swagger-maven-plugin v3 中没有描述文件

我想从 swagger V2 迁移到 OpenAPI v3。

对于 swagger V2,我使用com.github.kongchen:swagger-maven-plugin插件根据我的代码生成我的 swagger 文件。我迁移到io.swagger.core.v3:swagger-maven-plugin成功。唯一缺少的部分是

我在旧插件中使用它来丰富生成的 swagger 文件,其中包含一些基本信息。

我找不到任何办法这样做io.swagger.core.v3:swagger-maven-plugin。可能吗?

0 投票
0 回答
225 浏览

openapi - swagger-maven-plugin 不会在 openapi 文件中生成两种内容类型

我有一个 jaxrs 应用程序,它有两个资源路径,每个路径都产生不同的内容类型。我正在尝试生成一个 openapi 文件(与 swagger-ui 一起使用),但只生成了一种内容类型。

看这个例子:

如果我运行 swagger-maven-plugin

它产生

我的问题是它只生成文本/html。当我将两者@Produces合并为一个资源时:

然后它产生

难道我做错了什么?或者这是一个错误?

0 投票
2 回答
1588 浏览

openapi - 使用 swagger 代码生成的 Post 请求中的无效日期格式(打开 api)

嗨,我正在使用我的 pom.xml 中的以下配置在我的 Spring Boot 项目中使用 swagger code gen (v3) 生成服务客户端

我面临的问题是通过上述配置生成的 Api 客户端执行 POST 请求时。POST 请求看起来像

这里startDateendDateJava 类中的 LocalDate ,它们也是由 Open Api 规范生成的。在这里,我不明白为什么它要转换为方括号 [],因此接收此请求的其他系统会抛出无效日期异常

请让我知道如何解决此问题并详细解释,因为我是 Swagger 代码生成的新手。

0 投票
1 回答
89 浏览

jersey - Jersey 1.x - 将 Swagger 1.x 提升到 2.x

我有一个正在使用 Swagger 1.6 的 Jersey 应用程序

以下是项目pom文件中的重要部分

这工作正常,并且在构建过程中生成的静态文档是正确的。当 Swagger 更新为使用 Swagger v3 时,如下所示

尽管插件的 3.x 版本支持 Swagger 3 注释,但文档已生成,但缺少描述(似乎未考虑 v3 注释)。为了解决这个问题,插件的版本被更改为,3.1.8但后来我在mvn clean install.

Null 指针异常的原因是什么,或者 Swagger 3 注释虽然受支持但未被考虑的原因是什么?

0 投票
2 回答
228 浏览

java - 有什么方法可以在 Spring 中使用 Swagger 包含控制器中未使用的类?

我正在使用 swagger-maven-plugin(kongchen) 生成静态文档,我想生成这样的 yaml:

但我也希望插件包含未在我的控制器中定义的类。

我的插件设置:

有没有办法使用 Swagger 来实现这个目标?它的主要目标是拥有可以导入到 Apicurio 并在我的应用程序中使用的 yaml。

或者,也许有任何方法可以生成包含所有此类的 yaml,而无需在任何控制器中使用它?

0 投票
0 回答
85 浏览

spring-boot - 生成的 OpenAPI 文件中未列出对象查询参数

我正在尝试在 swagger-maven-plugin 生成的 OpenAPI 文件中列出对象查询参数。我有以下端点,其中包含两个对象RecargaCupoFilter,并且Pageable每个对象都有自己的参数。

当我尝试生成 OpenAPI 文件时,我得到以下信息:

我希望有类似 SpringFox 生成的文件。

PS:我使用 swagger-maven-plugin 因为它在 Maven 构建阶段生成 OpenAPI 文件而不执行应用程序。

0 投票
0 回答
122 浏览

java - swagger.core.v3下的属性排序问题

也许其他人有同样的问题,可以指出我正确的方向。

我有一个使用 Swagger (v2.1.6) 和 swagger-maven-plugin (v2.1.5) 的 Java REST API。给出了以下 Java 类:

swagger-maven-plugin 生成的内容如下:

如您所见,属性默认按字母顺序排序。由于我已经有一些基于 swagger.json 生成的客户端,因此我需要按照它们在 Java 类中定义的顺序来设置属性。不幸的是,我一口气从 swagger-core 1.5.21 切换到 2.1.6 :(

是否有可能避免 @Schema 注释属性的字母顺序?也许一些用于 swagger-maven-plugin?

我也发现了这个讨论,但这些主题并不真正符合我的问题。

我很高兴有任何提示或解决方法。否则我需要更改很多代码,因为其他应用程序使用我生成的客户端:(

提前谢谢!斯特菲

0 投票
0 回答
140 浏览

maven - 如何使用 openapi-tools/swagger-maven-plugin 在 swagger 中生成安全方案

我需要在 maven 构建阶段生成招摇,为此我使用openapi-tools/swagger-maven-plugin

问题在于安全定义。

该插件的文档非常有限,我猜我无法使用正确的语法。这就是我正在做的

下面是我的 myApp.json 文件

0 投票
0 回答
18 浏览

java - 端点规范(“路径”字段)未在由 swagger-maven-plugin 生成的 Swagger API 规范文件中生成

我有一个简单的带注释的 API(一个 GET 和一个 POST 方法)。我正在尝试使用 swagger-maven-plugin 生成 Swagger API 规范文件。正在创建 Swagger API 规范文件,但问题是它只有 API 元数据,并且没有生成有关端点的信息,即没有生成“路径”字段。

我的 pom.xml :

Driver.java 类:

DriverController.java 类:

SwaggerConfig.java 类:

swagger-maven-plugin 生成的 API 规范文件是(在运行mvn compile时):

如您所见,上述规范中没有关于端点的信息。请帮忙。

提前致谢!