问题标签 [springdoc-openapi-ui]

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

java - 如何为请求参数允许多个预定义(枚举)值?

我想接收查询字符串参数的多个值,例如:

同时将允许的值限制为预定义的集合。

我已经找到了如何限制允许的值,现在如何允许输入多个值?

这是我当前的代码:

如果我删除 @Parameter 注释,swagger-ui 会显示一个“添加项目”按钮。

0 投票
1 回答
1481 浏览

kotlin - springdoc-openapi:如何在 coRouter DSL 中使用 @RouterOperation

我将 springdoc-openapi 与 Kotlin 和 WebFlux.fn 一起使用。
我想在 CoRouterFunctionDsl 的每个路径上使用 @RouterOperation 注释,但我做不到。

似乎没有任何相关文档。
如何在 coRouter DSL 中使用 @RouterOperation?

0 投票
1 回答
673 浏览

spring-boot - 将 HttpServletRequest 作为方法参数传递时,Springdoc 招摇是不可能的吗?

我有以下 springboot 休息控制器并使用 springdoc-openapi。我的 springboot 休息服务必须迎合一些遗留应用程序(这是调用此服务的唯一客户端),我需要将 HttpServletRequest 作为参数。

我正在生成 swagger openapi doc,当我到达 swagger-ui.html 时,我看到 rerquest 正文来自 Httprequest 参数方法,uri path = '/personhttprequest' 但不是当参数是 HttpServletRequest 时。我在这里看到 https://springdoc.org/faq.html#what-are-the-ignored-types-in-the-documentation

但我不清楚为什么以及如何让 HttpServletRequest 参数在 swagger ui 中工作。我想将它作为 text/xml 传递,就像我可以让它在下面的 HttpRequest 中工作一样。在此处输入图像描述我已经为“/personhttprequest”附加了 scrrenshot,当 xml 出现时,您会看到请求正文的框。如何使它适用于“/personhttpservletrequest”?

这是 git 集线器: https ://github.com/vmisra2018/sb-example-swaggerdoc

0 投票
1 回答
1569 浏览

spring-boot - Springdoc GroupedOpenApi 不遵循使用 OperationCustomizer 设置的全局参数

用于GroupedOpenApi定义 API 组时,添加到每个端点的通用参数集不会出现在参数列表中。下面是各自的代码

以及将标准标头添加到所有端点的类

实际输出

实际输出

预期产出

预期产出

要重现该问题,请克隆https://github.com/debargharoy/springdoc-test

解决方法

在应用程序属性文件中添加要包含/排除的路径可以解决该错误。但是代码级别的东西将不胜感激。

0 投票
1 回答
1172 浏览

spring-boot - Springdoc Swagger 3 - 添加 API 组后无法加载 API 定义

在我添加以下代码将端点分组到默认组之前,我有一个可以与 Springdoc 完美配合的 Spring 引导应用程序。

一旦添加这部分代码,我就会收到以下错误

未能加载 Api 定义 - 获取错误

知道有什么问题吗?

Springdoc v1.4.3

春季启动 2.x

0 投票
1 回答
878 浏览

swagger-ui - OpenApi 在请求中隐藏模型属性

我知道我们可以使用此链接@ApiModelProperty中的此注释来隐藏请求时使用idSwagger-Ui

但我正在使用这个 spring doc OpenApi 依赖项

当我@ApiModelProperty使用springdoc-openapi-ui. 这可能是什么注释?

0 投票
1 回答
299 浏览

spring-security - 即使在springdoc中进行身份验证后也无法点击控制器

我在我的项目中使用并springdoc version 1.4.3使用以下配置为我的 springdoc 我能够访问swagger-ui.html但是当我授权(通过 swagger-ui 输入令牌)并尝试从我的休息控制器获得响应时我不断被拒绝访问。springdoc-security version 1.4.3spring bootspring security

这是我要击中的控制器

从 swagger-ui 看 curl 的样子:

从邮递员那里打我的控制器是可行的,但使用 swagger-ui 不起作用,我的要求是从后者那里得到它。

0 投票
1 回答
5013 浏览

java - org.springframework.beans.factory.BeanCreationException:创建类路径资源中定义的名称为“webHandler”的bean时出错

将开放 API 添加到 Spring 云网关项目会导致错误为

Gradle 依赖

0 投票
2 回答
1225 浏览

spring - 带有 webflux 的 Springdoc openapi:显示自定义 json/yml 文件而不是生成的文件

我有一个简单的服务描述文件 open-api.json:

我在我的 Spring-webflux 项目中使用了 springdoc-openapi-webflux-ui:

是否可以显示现有文件而不是生成的文件?任何帮助,谢谢!

0 投票
1 回答
480 浏览

swagger - springdoc-openapi-ui 无法渲染 Protobuf 模型导致浏览器崩溃

springfox-swagger-ui迁移到springdoc-openapi-ui会导致此处描述的相同问题: https ://github.com/springfox/springfox/issues/2459

我也遇到了springfox-swagger-ui的问题,但我能够使用此处描述的类似方法使其工作: https ://github.com/springfox/springfox/issues/2468