问题标签 [springfox-boot-starter]

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 投票
0 回答
111 浏览

swagger-ui - Openapi Springfox 3.0 示例

我有一个 yaml 文件,其中包含请求正文的示例。但是 springfox 生成的 swagger-ui springfox 生成的 json 文件不显示请求正文示例,这使其显示模式示例。

显示请求正文示例的任何解决方法?

#openapi #swagger-ui #springfox

json输出

0 投票
1 回答
146 浏览

spring-boot - 将 Springfox 从 2.x 升级到 3.0.0 后,Swagger UI 呈现错误

我正在开发一个 Spring Boot 2.2.x 应用程序。我已按照以下说明将 Springfox 版本从 2.5.x 升级到 3.0.0: 从 2.x 迁移到 3.0.0

Swagger/Springfox 配置:

在 Springfox 2.5.x 生成的 Swagger UI 中,我可以看到 CSS 中的样式标签按预期工作。但是使用 Springfox 3.0.0,我可以看到页面没有加载 CSS 文件,因此将大部分 HTML 显示为文本。

在此处输入图像描述

关于为什么 CSS 没有出现在图片中的任何想法?

0 投票
0 回答
194 浏览

spring-boot - SpringBoot - SpringFox Starter 3.0.0 - 无法检测到 WebFlux RouterFunction

我正在为该项目使用 SpringBoot WebFlux Springfox-starter。

问题是这没有检测到 RouterFunction 方法。上述方法检测没有任何问题,但它不适用于 RouterFunctions。

https://github.com/springfox/springfox

我在以下位置托管了整个项目。如果有人遇到此处缺少的相同或其他配置,请告诉我。

https://github.com/chamithchathuka/demowebflux-2

在此处输入图像描述https://github.com/chamithchathuka/demowebflux-2/tree/master

0 投票
1 回答
72 浏览

spring-boot - OpenApi:无法使用 OperationBuilderPlugin 覆盖内容类型

我浪费了很多时间试图弄清楚如何在SpringFox (Docket openapi v3.0) 生成的api-docs的输出中为我的 Spring 控制器设置默认 MediaType。最后,我发现了一个几乎未记录的接口OperationBuilderPlugin,理论上它允许我在 OperationContext 中设置一些属性,但不幸的是,尽管在构建操作时我正在寻找的属性似乎被忽略了:

还尝试将产品直接设置到 Docket 中,但仍然没有运气

我不想在控制器类级别(或方法级别)指定返回 MediaType,所以如果我找不到更干净的解决方案,我最后的机会是在下载 api 后用我想要的媒体类型手动替换 */* -docs.json 来自远程 url。

有人遇到过同样的问题吗?任何帮助将不胜感激,在此先感谢

0 投票
0 回答
54 浏览

java - springfox 3.0.0 版:对于相同的方法签名,根据需要放置字段

我迁移到 springfox 3.0.0 并在迁移后招摇开始根据需要显示一些查询参数

昂首阔步

我想拥有相同的方法签名,但通过参数识别请求的差异例如:

结果,我根据需要具有include[association]参数,但我想将其作为可选参数。

0 投票
2 回答
224 浏览

spring-boot - 我可以让 /swagger-ui.html 重定向到 /swagger-ui/

在 springfogx-swagger-ui 3.0.0 中,我的 Spring Boot 应用程序以http://myapp.example.com:8080/swagger-ui/上的 Swagger UI 结束。我的用户习惯于将该 URL 视为http://myapp.example.com:8080/swagger-ui.html。有没有办法可以设置重定向或其他方式让“知道” http://myapp.example.com:8080/swagger-ui.html的用户被路由到“正确”的 URL http://myapp。 example.com:8080/swagger-ui/

我以“通常”的 Spring Boot 方式同时获得了 swagger 和 swagger-ui

无论如何,这可能是一个比 Spring Fox 问题更多的 Spring Boot 问题。重定向似乎是无忧无虑的完整解决方案。

0 投票
0 回答
55 浏览

swagger - 如何让 Springfox Swagger 将我的 @ApiParam 列为对象,而不是将其各个成员列为参数,就好像它们都是参数一样?

我正在使用 Springfox 3.0 并有一个具有如下方法的 Controller 类:

但是,在此 API 调用的 swagger-ui 页面中,它列出了 的所有成员,MyImportedPOJO就好像它们是单独的参数一样,就像这样,但它识别MyRequestModel为一个对象:

我不知道它是否相关,但MyImportedPOJO来自我正在导入的库,所以我不能向它添加任何注释。

这就是我设置 Springfox 的方式: 在 build.gradle 中:

在我的MvcWebConfig

0 投票
0 回答
35 浏览

java - Java:如何摆脱使用 spring fox 创建的 swagger UI 中的模型类?

我正在 java 项目中的 spring fox 包的帮助下创建 Swagger UI。它生成所有 api 端点,但也扫描了许多模型类,这使得文档页面非常繁重。我不希望在文档中获取这些模型

在此处输入图像描述

我也尝试使用忽略的参数类型来忽略这些,但没有奏效

0 投票
1 回答
33 浏览

swagger - Swagger @ApiResponse 应该显示错误对象列表,即列表? 这怎么可能?

我使用的招摇版本如下,我的问题与 @ApiResponse 注释有关

当用户访问我的 api 并且用户提供了无效的详细信息/输入时,我的应用程序将返回用户输入中的错误列表。每个错误都被捕获在一个错误对象中

- 所以如果用户输入无效,我的应用程序响应将如下所示 -

---现在回到我的问题 -使用 swagger @ApiResponse 注释,我希望 api 用户知道响应格式。所以,我在下面尝试

但是上面没有用,我看到下面的编译时错误 -

语法错误,插入“}”完成 MemberValueArrayInitializer

我试过 - 其他组合也像下面但没有运气 -

那么,使用 @ApiResponse 注释表示错误列表的正确方法是什么? 因此,swagger doc 上的错误响应如下所示 -

0 投票
1 回答
112 浏览

spring-boot - 将 Springfox 3.0.0 添加到 SpringBoot 后抛出“检测到不明确的搜索映射”

我有一个 SpringBoot 应用程序(spring-boot-starter-parent:2.4.0),我想使用 Swagger。我遵循了这个Baeldung-Tutorial,不幸的是我在启动时遇到了这个异常:

org.springframework.context.ApplicationContextException:无法启动 bean 'documentationPluginsBootstrapper';嵌套异常是 java.lang.IllegalStateException:检测到不明确的搜索映射。

这是因为在某些情况下我会在我的存储库中重载方法,如下所示:

异常说这两种方法

映射到 /findByConversationId!调整配置以获得明确的路径!

有没有办法克服这个问题?谢谢 !