问题标签 [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 回答
512 浏览

swagger - 嵌套复杂类型中的SpringDoc swagger文档生成异常

我们有一个 Person 类。Person 类有一个 PersonDetail 类型的属性。而且 PersonDetail 有一个 Mail 类的属性。

当我们启动应用程序并导航到 swagger ui html 页面时,未在 openapi 定义的组件部分生成 Mail 类,我们得到“无法解析引用:无法解析指针:/components/schemas/Mail 不存在于文档中”页面错误。当我们检查第三级是否存在复杂类型时,springdoc 无法解析该类型。Person 和 PersonDetail 工作正常,但 Mail 失败。

人员->人员详细信息->邮件

0 投票
2 回答
4336 浏览

spring-boot - springdoc-openapi swagger-ui 中的 CSRF 支持

当使用与 springdoc-openapi 捆绑的请求时,有没有办法自动将 CSRF 标头包含到从 swagger ui 发出的请求中?

在 springfox ( GitHub )中似乎实现了类似的解决方案,但我没有找到有关这是否可以通过 springdoc-openapi 完成的信息。

0 投票
1 回答
402 浏览

java - 加载 swagger UI 时对所有服务的 Spring 安全调用

我正在使用 springdoc-openapi-ui。当我加载我的招摇页面时,会在加载招摇 UI 时为所有 API 调用 spring-security。我有弹簧安全。我的期望是当我尝试从 swagger 中访问特定的 API 时应该调用安全性。

我的招摇 UI 链接如下所示

' http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config '

当我使用 springfox-swagger-ui 时,它按预期工作。最近我已经迁移到 springdoc-openapi-ui。

0 投票
4 回答
14988 浏览

spring-boot - Swagger UI 重定向到 /swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

我正在使用springdoc-openapi-ui,当我点击http://localhost:8080/swagger-ui.html URL 时,它总是重定向到http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs /招摇配置。有什么方法可以停止此重定向并在http://localhost:8080/swagger-ui.html上加载 swagger 。

0 投票
2 回答
7986 浏览

java - 如何为 springdoc-openapi 端点调用添加带有授权的标头

Swagger2 (springfox) 与:

Springdoc-openapi:

我无法为 springdoc-openapi 实现它。似乎标题不起作用。

0 投票
2 回答
6056 浏览

swagger - Springdoc OpenAPI ui 不遵守“位置”中的上下文路径

设置:

我正在使用springdoc-openapi-ui1.4.0 版(通过 Maven)中的 Java 库,而在一个简单的 spring-boot 项目中没有任何自定义。

Swagger 页面在 https://my-url.com/my-context-path/swagger-ui/index.html下生成

以及https://my-url.com/my-context-path/v3/api-docs/下的 api-docs

这两项工作,我可以达到他们。到目前为止,一切都很好!

现在的问题:

当简单地导航到https://my-url.com/my-context-path/swagger-ui.html我得到一个 HTTP 状态 302 和一个location在响应标头中设置的属性,该属性应该将我重定向到招摇页面从上面(我假设)。

但是,location属性中的 URL 错过了上下文路径!它看起来像这样: https ://my-url.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

它重定向到一个不存在的页面,我收到 404 错误代码。请注意,configUrl 似乎也缺少上下文路径。

任何想法为什么会发生这种情况以及如何解决?

这个 Github 问题似乎是同样的问题,但最后指出问题已得到解决:https ://github.com/springdoc/springdoc-openapi/issues/37这是我之前的版本。

0 投票
1 回答
211 浏览

spring - 如果使用 springdoc-openapi 库,如何在 swagger-ui 中公开 Spring 的 HttpSecurity Logout 端点?

我找到了在 swagger-ui 中为 springfox 公开 Spring注销端点的解决方案: Configure Swagger-UI to pick up Spring's HttpSecurity Logout endpoint

但老实说不知道如何为 springdoc-openapi 制作它:https ://springdoc.org/

0 投票
1 回答
283 浏览

springdoc - 禁用按字母顺序排序字段值

我正在使用 Spring Boot (v2.1.3 RELEASE) 和 SpringDoc。我已经浏览过https://springdoc.org/springdoc-properties.htmlhttps://springdoc.org/,但看起来 SpringDoc 会自动按字母顺序对参数进行排序。我们怎样才能防止这种情况发生?

0 投票
1 回答
2858 浏览

java - 授权标头未显示在 CURL springdoc-openapi-ui 中

我正在使用springdoc-openapi-ui. 我已经配置了名为Authorization. 当我执行 APIAuthorization时,请求的 CURL 中没有显示。我的其他参数显示在 CURL 中,除了Authorization.

以前,我使用的是springfox-swagger-ui,当时它显示在 CURL 部分。

我搜索了相同的内容并在https://swagger.io/docs/specification/describing-parameters/#header-parameters上找到了注释 Note: Header parameters named Accept, Content-Type and Authorization are not allowed.

但我要求Authorization仅用作标题。我们有什么办法可以做到这一点吗?

SwaggerConfiguration的添加在下面。

0 投票
2 回答
1528 浏览

java - 如何在 Spring Boot 中添加对 Swagger 的 I18N 支持

我正在使用springdoc-openapi-ui swagger。我不想硬编码swagger documentation. 我想从属性文件中读取这些值。

当我尝试出现编译错误时The value for annotation attribute Operation.summary must be a constant expression.

我知道它正在寻找常量表达式,但我不想在我的代码中硬编码这些值。

在此处输入图像描述

请在此处找到我的控制器代码

有没有办法在端点注释中添加不同语言的消息属性?