问题标签 [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.
java - 从 swagger 2 注释生成 openapi3 json 的 Maven 插件
项目使用来自这个包的 swagger 2 的注释:
然后生成swagger json:
但是该插件无法为openapi 3生成json。是否有任何maven插件可以使用上述包中的注释生成openapi 3 json?
jax-rs - Swagger Maven 插件未从 @BeanParam 注释参数生成参数
如标题所述,我对 swagger maven 插件的配置似乎跳过了带有 @BeanParam 注释的参数。
我已经按照与 github 上的示例相同的方式配置了我的代码(如下链接所示),所以我不知道会出现什么问题。
这是我目前的配置
我的输入文件
我的输出招摇文件
是什么导致输出中的参数数组保持为空?我所有没有 bean 注释的方法都可以正常工作。
java - 如何使用 swagger-maven-plugin 序列化类的 Instant 字段?
我有这个领域的课程:
当我从此源(使用 swagger-maven-plugin)生成 yaml 时,我得到:
因此,当我从 yaml(使用 swagger-codegen-maven-plugin)生成回我的类时,我使用以下字段得到它:
为什么 Instant 转换为 Long?
java - 为什么@ApiModelProperty 注释的“示例”属性中有多余的反斜杠?
我使用 swagger-maven-plugin 从一个 api 方法源代码生成 yaml:
在生成的 yaml 中,我有:
之后,我使用 swagger-codegen-maven-plugin 将 api 方法生成回 java 并得到了这个:
还有更多 - 在为 tis api 方法生成的控制器中,我有另一个结果:
这里的代码被破坏了!\\" - 不是有效的序列
maven - 在 swagger maven 插件配置中包含 info 对象
我无法在我的 swagger 输出 json 文件中包含一个 info 对象。我正在使用来自https://github.com/swagger-api/swagger-core的 swagger-maven-plugin 。这是我尝试过的...
我试过在我的 pom.xml 中包含一个 info 对象,像这样......
/li>
我还尝试在我的路径中添加一个 openapi-configuration.yaml 文件。该文件看起来像这样。我从插件 repo 自述文件页面复制了这个文件,所以内容与我上面的第一种方法不同。
这些方法都不起作用。
我错过了什么?干杯。
spring - 如何为 swagger 代码生成器创建的模型验证 spring rest 控制器中的字段?
我们正在使用 swagger 代码生成器工具来创建模型,并且该模型用作 spring boot rest api 输入有效负载,以及如何验证生成的模型类类似于 @valid 注释
rest - 如何将 API 分类为两个不同的 swagger 文档?apiModelPropertyAccessExclusions 不起作用
我们正在使用 swagger-maven-plugin 来生成 swagger 文档。我们为每个类和相应的方法(所有 API)都有适当的注释。我们需要生成 swagger 文档,并且它与我所有的 API 一起生成在一个文档中。
要求:是否可以根据某些分类生成两组swagger文档?这里我试图用“public”和“private”进行分类
根据https://github.com/kongchen/swagger-maven-plugin/ blob/master/README.md,
我使用了 apiModelPropertyAccessExclusions但它不起作用。
@ApiModelProperty(name="addReport", access=" public ", hidden=true)
pom.xml::
请帮帮我。
java - Swagger/OpenAPI 3.0 生成 - 具有来自接口的通用列表的端点未显示在文档中
我正在尝试使用 Swagger / OpenAPI 3.0 为 Java EE 应用程序生成 API 文档/swagger 客户端,但文档中始终缺少一种方法。我创建了一个示例项目来澄清我的问题:
新的,不太复杂的例子:
我得到了一个带有列表的接口作为我的 REST 端点的参数:
我将实现此服务并添加 swagger 注释:
我尝试使用 maven 插件生成 openapi 文档(完整配置见下文):
但是生成的文档仍然是空的,端点没有出现:
更复杂的例子
我的休息端点实现了一个带有类型参数的接口。我尝试了几种方式使用这个参数,导致这个界面
实现该接口的服务如下所示:
使用 2.1.1 版中的 Maven 插件 io.swagger.core.v3.swagger-annotations 生成 openapi 文档,从而生成包含每个方法的文档,但是Response pongList(List<T> pongs);
该类型参数的所有其他使用都以某种方式很好地工作,只有当我使用 type 参数作为列表的类型,我无法让它显示出来。
插件配置:
完成 pom.xml
我不太明白。为什么Response pongList(List<T> pongs);
文档中缺少该方法?也许你可以告诉我:-)。
问候!
java - 如何在子资源类中使用@Api swagger注解?
在我的项目中,我有一些子资源,根据 Jersey 框架指南正确实施。
但是,我在生成 openapi.json 文件(由 swagger-maven-plugin 生成)时遇到问题。特别是,我希望能够在@Api
实现子资源的类上使用 swagger 注释来应用一些属性,例如授权。
问题是,如果我在子资源类上使用@Api 注解,swagger 不仅将这些类视为子资源,而且将其视为资源。结果是在 openapi.json 文件中,对于每个子资源,都会生成相同的资源(不应该存在)。
根资源:
子资源:
我也尝试过使用@Api(value="")
or @Api(value="sub_a")
,但它们不起作用或使事情变得更糟。显然,如果我删除 @Api 注释一切正常,但我被迫逐个应用属性操作。
有什么建议么?
maven - 使用 swagger-maven-plugin 3.1.7 生成的空 swagger.json
我正在使用 swagger-maven-plugin 3.1.7 如下:
我添加了以下招摇依赖项
我的控制器带有注释
但我仍然得到一个空的 swagger.json 文件。
这是多模块项目的一部分,其中出现错误。在非多模块项目中添加相同的依赖项和流程完全可以生成 swagger.json。
如果我做错了什么,有人可以告诉我吗?