问题标签 [springfox]

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

java - Springfox/Swagger 中用于返回 ObjectNode 的自定义 ResponseModel

我想使用 Swagger 为我的 Spring Boot API 提供 API 文档。我设法让 Springfox 2.3.0 工作,一切都按预期工作,除了控制器返回一个 ObjectNode。Swagger 尝试将返回的类 (ObjectNode) 转换为 JSON-Representation,结果如下:

现在我知道,Swagger 无法猜测我构建的 JSON 中包含哪些值,但我想以任何形式手动添加正确的 ResponseModel。

控制器看起来像这样:

有什么方法可以向 Swagger 提供自定义的 ResponseJSON,它在文档中显示为模型模式?

0 投票
1 回答
2260 浏览

properties - SpringFox Swagger 使 XSD 模型所需的定义属性

我有一个 REST webapp,它使用 Swagger 作为文档,除了 body 参数之外它运行良好。body的所有属性都是可选的

招摇-ui

我的 Project 对象是使用 XSD 文件生成的,我确保minOccurs=1 maxOccurs=1 或 unbounded的所有元素以及我的所有属性都设置为use=required。这似乎对它没有任何影响。我尝试的下一件事是添加

@ApiParam(value = "项目主体", required = true) @RequestBody ProjectInfo 项目

但这也没有效果,因为 Project 对象本身已经是必需的。有没有办法告诉 Swagger Project 的属性也是必需的?我正在使用 Swagger 的 SpringFox 依赖项。

更新

我设法通过将@ApiModel@ApiModelProperty(value = "The unique name of the project", required = true)添加到我生成的模型中来获得它。

但是现在我的问题变成了我可以在 XSD 文件中添加 Swagger 注释以便它自己生成吗?

0 投票
1 回答
851 浏览

java - 在 Swagger 中更改方法的主体请求中的参数

我一直在做一个项目,并尝试使用 Swagger-2.0 对其进行记录。在这个项目中,由于一些安全问题,控制器中每个具有对象作为返回类型的方法都应该将返回对象更改为完全扁平的对象。为了做到这一点,我们在每个方法上方使用了一些自定义注释,并且控制器本身将对象转换为返回类型。我的意思是,该方法返回的对象与传递给浏览器的对象不同。对于控制器中方法的输入参数,我们也有同样的事情。这意味着用户必须为方法发送一个与方法的输入参数不同的对象。下面有一个示例方法作为示例。

问题是如何配置 Swagger 以识别InputParamViewReturnObjectView作为该方法的输入参数和返回类型。我们通过使用ApiOperation每个方法上方的注释来为方法的返回类型执行此操作,如下所示。

不幸的是,我已经找到了对输入参数做同样事情的任何方法。我想知道是否有人通过适当的例子帮助我解决这个问题。

0 投票
0 回答
846 浏览

java - 用于 SpringMVC 的 Swagger Springfox 无法正常工作

我正在使用springfox自动生成swagger json。目前我正在使用springframework 4.2.2。这是我配置的简单内容。

毕业典礼

SwaggerConfig.java

问题是我在、<code>localhost:8080/{myapp}/v2/api-docs 中没有看到任何 api-docs localhost:8080/v2/api-docs,我在这里做错了什么?

编辑:

如果需要,这是我的 web.xml 和 applicationContext.xml 和 rest-servlet.xml。

Web.xml

应用程序上下文.xml

休息-servlet.xml

0 投票
1 回答
2852 浏览

java - Springfox Swagger2 - @ApiOperation 不工作

我将 springfox-swagger2 用于我的 Spring MVC REST API。一切都适用于 swagger,但我的问题是我无法在我的 swagger 文档中添加其他信息。

Maven依赖:

我的 Swagger 配置类:

我的控制器类:

因此,调用 swagger-ui 会显示控制器、方法以及除我在@ApiOperation和中定义的附加信息之外的所有内容@ApiImplicitParams。有谁知道问题出在哪里?参数也不在从 swagger 创建的 JSON 文件中。

0 投票
0 回答
1013 浏览

java - 如何使用 asciidocltor-maven-plugin 从通过 springfox-staticdocs 以 ascii 格式生成的 ascii 文档生成 html 文档

我正在使用 swagger2 生成我的 api 文档,并且通过 springfox-staticdocs 使用来自 swaggwer 的相同 json 输出来生成 ascii 静态文档。ascii 格式的静态文档在 junit 测试类中生成。现在我想通过 asciidoctor-maven-plugin 从测试阶段生成的 ascii 文档生成 html 文档,但是不知何故 html 文档没有生成,我什至看不到 process-asciidoc 目标被执行。我将“process-asciidoc”目标绑定到准备包阶段,因为 ascii 文档是在测试阶段生成的。我在这里做错什么了吗。

mvn包

pom.xml 片段:

这是使用 springfox-staticdocs lib 生成 ascii 文档的测试方法片段:

0 投票
1 回答
3944 浏览

java - 如何将 Java Swagger Annotation 转换为 Swagger json 模式?

如何从包含 Swagger 特定注释的 java 文件生成 JSON 文件,以便 Swagger-UI 可以读取它。

0 投票
1 回答
410 浏览

spring - pom依赖中的springfox是什么?

什么是春狐。我在 pom.xml 属性中看到了。但我无法理解springfox。

像上面一样,我不明白它的含义以及它是如何工作的。我搜索了它,但没有任何信息 springfox 是什么。

0 投票
0 回答
1937 浏览

spring-boot - POST 的 Spring Boot Swagger UI 中的 400 错误请求

我用 RestController 创建了一个 Spring Boot 应用程序。我启用了 Swagger UI,它运行良好,因为我可以登录 UI 并执行任何 GET 方法。但是对于接受正文中的对象的 POST 方法,当我使用 Swagger UI 触发请求时,它总是返回 400 状态代码。我可以看到请求从未到达特定的 POST 方法。我可以知道 Swagger UI 是否需要任何特殊配置?

我的 Spring Boot RestController 中的特定方法

我正在使用

这个(由 Swagger UI 生成)对应的 api 给了我 400 错误请求:

但是如果我为相同的方法提供一个随机请求,它至少会达到我的方法:

0 投票
3 回答
23572 浏览

springfox - 如何为 springfox 修改 swagger-ui.html?

我正在使用 springfox 的招摇实现。我想修改 swagger-ui.html 以采用自定义标头值。如何修改此文件?或者告诉spring fox使用备用文件?