问题标签 [springdoc-openui]

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

aws-api-gateway - AWS API Gatewary 的 Springdoc 扩展

我想从 springfox 2 迁移到 springdoc。目前,使用 springfox 库中提供的支持实现了多个插件(springfox.documentation.spi.service.OperationBuilderPlugin)。AWS API Gateway 的插件就是其中之一(类似于这个http://springfox.github.io/springfox/docs/current/#example-operationbuilderplugin)。

我没有找到有关如何使用 springdoc 支持构建类似内容的相关示例或详细文档。

任何建议将不胜感激!

0 投票
0 回答
192 浏览

springdoc - org.springdoc.webmvc.core.SpringDocWebMvcConfiguration 方法 openApiResource 的参数 4 需要单个 bean

在启动时将 springdoc 与 springboot 一起使用时出现此错误

我正在使用以下版本或springdoc

以及以下带有启动器执行器的弹簧启动父级

关于如何解决这个问题的任何想法?我为 spring doc 获取了最新版本,但它并没有解决我的问题

0 投票
1 回答
1152 浏览

spring-boot - springdoc-openapi 如何将字符串数组显示为响应

网上没有关于如何使用 springdocs-openapi 库 (1.5.7) 获得以下输出的好例子。我正在寻找以下输出:

这是基于提供的示例的代码。

这导致以下输出

上面列出的输出 ["A","B","C"] 如何通过 springdocs-openapi 库实现?

0 投票
0 回答
24 浏览

spring-boot - Spring Boot 大摇大摆地展示 api-doc

我正在使用 springboot 应用程序,我们使用 springdoc-openapi-core 成功地与 springdoc 集成,并且我们在服务器中部署了 swagger。现在我们还需要保护 api-docs 和 api-docs.yaml 端点,为此我们需要 /api-docs 和 /api-docs.yaml 端点在 swagger 中可见。我们如何做到这一点?所以我的问题是,springdoc 有没有办法让 /api-docs 和 /api-docs.yaml 包含在 swagger 文件中。

0 投票
1 回答
489 浏览

swagger - springdoc / Swagger UI 未将 OAuth2 令牌传递给 API

我正在使用 springdoc (v1.5.9) 为 API 生成 Swagger 定义。在 Swagger UI 内部进行身份验证并执行安全方法后,Spring Boot 应用程序接收到的 http 请求没有 Authentication 标头。我已通过 JS 调试器确认 Swagger UI 接收并存储了有效的身份验证令牌。

下面是 HTTP 请求、显示定义/应用于方法的安全方案的 Swagger api-docs、springdoc 配置和控制器。

我如何需要更改/添加到我的 Spring 配置以获取从 Swagger UI 传递给 API 的授权?

收到 HTTP 请求

api文档

OpenAPI 配置

控制器

0 投票
1 回答
351 浏览

swagger - 渲染 Swagger OpenAPI v3 UI + Springboot 项目的问题

我收到错误消息 - “请指明有效的 Swagger 或 OpenAPI 版本字段。支持的版本字段是 swagger:“2.0”和与 openapi:3.0.n 匹配的那些(例如,openapi:3.0.0)。 “当我粘贴时从 /api-docs 到 editor.swagger.io 生成的 json。 我有一些观察。

  1. localhost:8080/v3/api-docs/yield - "{\"openapi\":\"3.0.1\", "\info\":{ ---------------- 这个 json 在 editor.swagger.io 中给出了提到的错误。

  2. 在手动删除初始双引号和转义字符时,即 {"openapi":"3.0.1", "info":{ ----------------错误消失,即 UI 呈现没有任何问题。

  3. 我的项目springboot版本是2.2.13.RELEASE,springdoc-openapi-ui版本是1.5.8,jackson-databind版本是2.10.5.1

  4. OpenAPI 配置类 -

如果我需要任何进一步的信息,请告诉我。有关该问题的任何意见都会有所帮助。谢谢你。

0 投票
0 回答
559 浏览

java - 当我包含大型资源文件并构建/运行 JAR 文件时,为什么我的 Springboot Springdoc /swagger-ui.html 端点返回 404?

当存在大型资源文件(例如,每个 ~380Mb 的 7 个文件)时,为什么 SpringDoc swagger-ui.html 返回 404 / Whitelabel 错误页面?这是在构建和运行 JAR 文件之后发生的。当项目直接从 Intellij 运行时,端点工作正常。

我已经能够使用 SpringDoc 演示存储库复制该错误。访问时的预期行为/swagger-ui.html是让 swagger-ui 页面加载显示图书服务资源。但是,当存在大型资源文件时,我得到的是 404,日志显示:

重现

  1. 克隆https://github.com/springdoc/springdoc-openapi-demos
  2. 创建7个大型资源文件: head -c 400000000 /dev/urandom > BigTestFile1.bin head -c 400000000 /dev/urandom > BigTestFile2.bin head -c 400000000 /dev/urandom > BigTestFile3.bin head -c 400000000 /dev/urandom > BigTestFile4.bin head -c 400000000 /dev/urandom > BigTestFile5.bin head -c 400000000 /dev/urandom > BigTestFile6.bin head -c 400000000 /dev/urandom > BigTestFile7.bin
  3. 创建一个名为LargeFilesspringdoc-openapi-book-service src/main/java/resources 的文件夹,并将所有 7 个 TestFiles 放在该文件夹中。
  4. 构建罐子mvn clean package
  5. 运行罐子java -jar ./target/springdoc-openapi-book-service-3.1.6-SNAPSHOT.jar
  6. 导航到 http://0.0.0.0:8080/swagger-ui.html。

我一直在研究许多 API——这个问题似乎只在存在大型资源文件时才会出现,并且仅在构建/运行 JAR 文件之后才会出现。

0 投票
1 回答
123 浏览

java - 如何在 Springdoc OpenAPI 3.0 中控制标签顺序?

我正在从 Springfox 3.0 切换到 OpenAPI 3.0 + Springdoc-openapi。
在 Springfox 中,标签顺序是按字母顺序排列的,但在 Springdoc 的 Swagger UI 中,顺序似乎是随机的。

如何控制 UI 上的标签顺序?我更喜欢我选择的排序,但可以按标签名称的字母顺序排序。

所需顺序:

  • 分页端点
  • 用户访问
  • 标记
  • 标记 - 管理员
  • 用户管理
  • 用户管理 - 管理员

实际订单:

  • 用户访问
  • 标记
  • 分页端点
  • 标记 - 管理员
  • 用户管理 - 管理员
  • 用户管理

POM 依赖项:

应用程序.yml:

0 投票
1 回答
46 浏览

springdoc - springdoc-openapi-ui 如何将请求设置为 HTTPS

我发布的时候会使用HTTPS请求而不是HTTP,但是swagger原来的URL还是HTTP,我不知道怎么设置,而且原来springdoc-openapi-ui配置中也没有servers的文档

https://springdoc.org/index.html#properties 在此处输入图像描述

0 投票
0 回答
51 浏览

javascript - 自定义控件(富文本编辑器) - theme.min.js - 404 not found 错误

我正在开发具有自定义控件富文本编辑器(Tiny MCE 版本:5.10.0)的 openUI5 应用程序。当我在本地运行我的应用程序时,我没有发现任何错误,并且编辑器按预期工作正常。但是当我在管道中部署我的代码并在我的 QA 环境中检查时,它会给出 404 - not found 错误。此外,我生成的请求看起来像下面的屏幕截图中提到的那样。

部署环境请求

本地设置请求

根据我的理解,当您部署代码时,它会被应用程序缓存破坏文件缩小。当我们尝试访问删除突出显示的数字的相同请求时,您可以轻松访问所需的文件。我的富文本编辑器结构看起来与上述屏幕截图中描述的相同,类似于 Tiny MCE 网站上提供的标准 SDK 设置以供参考 - ( https://www.tiny.cloud/get-tiny/ )

任何帮助将不胜感激,以供将来参考。