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

java - 大摇大摆的枚举

我想知道如何在招摇中记录枚举。

根据JavaDoc

数据类型。有关支持的数据类型,请参阅文档。如果数据类型是自定义对象,请设置它的名称,或者不设置任何内容。在枚举的情况下,使用 'string' 和 allowableValues 作为枚举常量。

但是我没有找到一些好的Java示例如何真正使用它,规范在这里

爪哇

首次服务

二次服务

输入

输出

pom.xml

你可以在这里看到结果。

我看到的 HTML 输出有很多问题(缺少输出描述、错误的 URL、用于注释的描述),但我不知道如何克服的是枚举的使用。

tests-swagger\target\generated\apidocs\first.json应该是(我认为)

但是还有

我认为这$ref是一个问题......

任何的想法?

0 投票
1 回答
492 浏览

rest - Swagger-Springmvc:在 JSON 中获取未知字段

我有一个 REST API,我配置如下

abc中的一个方法注解如下

我使用 Swagger UI 生成的文档显示了找到的所有内容,但是无法为我的模型类 Account 生成模型 json。除了用户定义的“共享”类数组之外,帐户还由几个变量组成。它由另一个用户定义的类用户组成。

Account类注解如下:

为模型响应和请求显示生成的文档

请指导此处可能出现的问题。如何显示 json 版本的 Account 对象。谢谢你。

0 投票
1 回答
7033 浏览

java - 为什么swagger注解会生成带有默认路径前缀的api-docs

我使用下面的 maven 插件将 swagger 与我的应用程序集成在一起 https://github.com/martypitt/swagger-springmvc

我在我的 spring servlet xml 中配置了以下内容

我的招摇属性如下所示

documentation.services.basePath= http://payrollservice.com/customservice documentation.services.version=1.0

我生成的 api-docs.json 如下所示,我不确定为什么它没有基本路径以及为什么它有前缀“/default”

0 投票
1 回答
885 浏览

jersey-2.0 - 使用 swagger 从球衣生成 JSON 定义

我的目标是从我的 Jersey 资源中生成一个像这样的招摇定义。

为了得到这个,我的 pom.xml 看起来像:

我也有招摇/球衣依赖:

json 生成良好,但我为我的每个资源获取一个 json 文件,而不是只有一个

我错过了什么

0 投票
1 回答
712 浏览

java - 生成静态 api-doc

我需要在我们的 git 存储库中存储 swagger 静态生成的 api json 文件,以便轻松跟踪 API 更改。类似于这个 http://petstore.swagger.wordnik.com/api/api-docs/user

我附上了 maven 插件 https://github.com/kongchen/swagger-maven-plugin

到项目,它会为 API 生成 *.json 文件。但是,api 和属性的顺序有时会有所不同。因此 *.json 文件在没有任何 api 更改的情况下被修改(只是顺序不同)。

然后我为每个指定了“位置”参数

注解,

它主要是帮助。但是有一些服务会返回 org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput 和 javax.ws.rs.core.Response 类,并且这些类的属性仍然是随机顺序的。那么我用 /swagger-overriding-models.json 覆盖了这些类的 json 表示

现在它工作正常。我只是在徘徊,可能不是最好的方法,还有其他一些可能性可以按可预测的顺序生成 api json 文件,而不会弄乱“位置”和模型覆盖?

0 投票
2 回答
1891 浏览

spring-security - 启用 Spring Security 使 Swagger 输出 text/plain 而不是 HTML

招摇有效!我可以与http://localhost:8090/sdoc.jsp 交互,一切都很好。

我将以下内容添加到 pom.xml ...

我还添加了以下两个文件:

此时,如果我访问以前工作的相同 URL,我现在会得到一个“文本/纯文本”的响应类型,而不是一个漂亮的 HTML 浏览器,我看到的是源代码。

如果我恢复更改并从项目中删除这两个文件并删除 JAR 文件,它会再次起作用。

如何让 Spring Security 和 Swagger 发挥出色?我究竟做错了什么。

0 投票
1 回答
2448 浏览

java - 招摇包含模式()

招摇配置:

休息控制器

参考:一些信息已经从这里参考:http://java.dzone.com/articles/how-configure-swagger-generate

问题/问题:

在方法中SwaggerConfig.javaincludePatterns()当我给出模式时,/account/*API 不会出现在 Swagger 输出页面中,而如果我包含/account/.*出现的模式。为什么?/account/*在这个用例中和有什么区别/account/.*

更新:

另一个用例

如果我将模式添加为/score/*,则 API 将出现在 Swagger 中。我不需要把模式作为/score/.*

0 投票
2 回答
6111 浏览

java - 使用 maven 插件的离线 swagger 文档

我正在尝试生成招摇的文档,为此我需要启动服务器。我想离线生成 swagger 文档(不启动服务器),我刚得到这个链接 swagger-codegen-maven-plugin

但是当我将上面的插件添加到 POM.xml 时(假设在 maven 构建期间生成 HTML 文档,我觉得),它根本没有做任何事情。请帮忙。

0 投票
2 回答
872 浏览

java - 在哪里放置 maven 生成的 webapp 工件?

我正在使用 swagger maven 插件来生成我的 swagger.json 文件。我希望它可以作为 webapp (src/main/webapp) 中的静态资源使用。

在 github 页面上的示例中,他们像这样配置它。

我看不出这有什么用,因为它不在 webapp 文件夹中。我想您必须手动将其复制到有用的地方,但是如果它不是自动化的,那么 Maven 的意义何在。

我在我的项目中这样配置它。

这允许我在开发期间(作为 Eclipse 项目)和部署时(作为构建的 war 文件)访问该文件。

问题是是否可以在通常的 src/main 文件夹中弹出生成的工件?

我已经从 jaxb 生成了代码,但它进入了目标文件夹中的 generate-sources 文件夹。然后将其添加为 eclipse 中的源文件夹,并且 maven 知道将这些类添加到构建中。

我基本上只是想通过将我生成的代码转储到 src/main/webapp. 我知道我必须 gitignore 这个文件。

0 投票
1 回答
2743 浏览

java - 带有 Spring MVC 的 Swagger 2.0.3 抛出 HttpMediaTypeNotAcceptableException:找不到可接受的表示

我正在使用以下 Maven 依赖项和插件

在beans.xml下面是bean定义如下:

我参考了以下博客

我无法使用博客中提到的抢先体验版本,因为它无法下载。我已将版本更改为 2.0.3-SNAPSHOT,现在我看到 HttpMediaTypeNotAcceptableException 异常。我能够生成 WAR 文件,并且在日志中,当我尝试使用 http://localhost:8080/example/v2/api-docs访问它时,我能够看到使用 Swagger 正确创建的资源组,上面提到的异常被抛出。

请帮忙。