问题标签 [swagger-maven-plugin]

上下文：将 Swagger 从 1.2 规范中的当前 REST 文档转换为 2.0

环境：Java 8，swagger-maven-plugin 3.0.1，swagger annotations (com.wordnik)

我被困在哪里：我能够成功生成 REST API 文档。但是，REST API 需要一个 ApiKey 作为查询参数。在 1.2 规范中，这是使用 index.html 中的以下代码段添加的

但是，对于 2.0 规范，我的搜索导致 yaml 文件发生以下更改。

当前的 index.html 有以下 in window 函数：

当执行 gradle clean 然后 gradle swagger 抛出 ClassNotFoundException 。如果再次运行 gradle swagger（基本上是在上次运行中完成 api 构建之后），它工作正常。

build.gradle 如下所示：

Javadoc（通过 Maven）在我的 Java JAX-RS 接口方法签名中给了我以下错误：

这是我的 JAX-RS 接口：

Javdoc 给出了@Consumes. 这是 的定义APPLICATION_FORM_URLENCODED_UTF_8，它出现在MyAppConstants同一个项目中：

这是 的定义APPLICATION_FORM_URLENCODED，它出现在javax.ws.rs.core.MediaType：

这是 的定义CHARSET_PARAMETER，它也出现在javax.ws.rs.core.MediaType：

现在我问你：APPLICATION_FORM_URLENCODED_UTF_8编译时不是常量怎么办？

错误消息没有说我必须提供文字. 它说我必须提供一个常量。那么这不是一个常数呢？

（我几乎可以发誓这曾经有效，但突然停止工作。）

更新： 找到原因，但还是不明白。

出于某种原因，仅仅swagger-maven-plugin在 POM 中包含 就会触发这个问题！我的代码根本没有改变，但是只要我添加了以下依赖项，我就会突然收到现有代码的 Javadoc 警告！！！

单个依赖项如何使 Javadoc 在代码文件上以不同的方式工作？在swagger-maven-plugin做什么？

我在 Spring Boot 中有一个带有 Spring Data Rest 的应用程序，我正在尝试使用 swagger-maven-plugin 使用 Swagger 生成文档。Controller 文档的生成没有问题，但存储库没有。

我在 pom.xml 中配置了以下形式的 swagger-maven-plugin：

我的汽车存储库：

是否可以使用 swagger-maven-plugin 生成存储库文档？

我不知道我做错了什么。我们之前在 Jersey JAX-RS 项目中使用了 swagger-core 来生成 swagger.json。它影响了我们的性能，然后我们发现了 swagger-maven-plugin，它只会在编译时而不是运行时生成 swagger.json。所以我尝试过渡到 swagger-maven-plugin。我希望我理解这一点是正确的。我离开了 web.xml，因为它在 swagger-core 配置和 maven 依赖项期间也是如此，但是将插件添加到相同的构建中，如下所示：pom.xml

我不得不添加 pluginManagement 标记，因为执行标记给出了错误。顺便说一句，我在 eclipse 中做所有这些。

这是 web.xml 中的招摇配置，以防万一：

现在，我右键单击项目并选择 maven -> build -> clean install，它构建成功，但在 webapp 文件夹下我没有看到任何 output.html 或在“dist”文件夹中没有 swagger.json。我什至尝试通过 cmd 进入 git 项目，然后运行 ​​mvn compile。相同的。建立成功，但实际上什么也没发生。我究竟做错了什么？

我无法理解为什么 swagger-maven-plugin 不为 Spring Boot 中的参数生成定义。json看起来像这样

我希望它看起来像这样。参考架构

我在这样的 Spring Boot 应用程序中使用 swagger-maven-plugin

在控制器中它看起来

swagger-maven-plugin使用 Jackson 获取有关 DTO 属性的信息。我有自己的 Jackson 模块（可扩展com.fasterxml.jackson.databind.module.SimpleModule）-如何将其注入到招摇生命周期中？

我swagger-maven-plugin用来生成 swagger.json。但是，我注意到属性的顺序从运行到运行会发生变化。例如，它可以是：

然后在下一代之后：

我的Java课程：

我想使用 swagger 和 maven 插件从我的 restful 应用程序中生成 json-from 中的文档。创建了 json 文件，但是来自 api 的数据以及我的代码的所有描述都丢失了。

这是我的 pom.xml

这是我的java代码：

生成的 json 文件如下所示：

在此 Json 文件中，缺少来自 @ApiOperation、@ApiResponses 和 @ApiParam 的信息。由于未知原因，该插件未解析 swagger-Api 的任何内容。请有人可以帮助我正确生成缺少内容的此文件吗？

我正在使用 swagger-maven 插件为 spring boot 2 应用程序生成 swagger.yaml。该插件适用于默认字段，如信息、描述、供应商扩展等。

但是，我需要在生成的 swagger.yaml 中附加一些自定义 yaml。前任：

X-client-integration
名称：测试
包：测试包
目录：
-id：x
Seq：1
-id：y
Seq：2

这个附加的 yaml 可以硬编码或从项目的文件中复制。

有什么办法可以做到这一点？