问题标签 [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 投票
2 回答
544 浏览

spring-boot - java.lang.IllegalStateException:无法读取类 org.springdoc.core.SwaggerUiConfigProperties 错误的元数据

我有一个 Spring Boot 应用程序。我为 Swagger API 规范添加了以下依赖项。

它给出了以下错误:

java.lang.IllegalStateException:无法读取类 org.springdoc.core.SwaggerUiConfigProperties 的元数据

任何人都可以帮忙解决这个问题吗?在添加此依赖项之前,项目工作没有任何问题。

0 投票
1 回答
1073 浏览

java - 从springdoc中具有泛型类型字段的类中获取模式

我在springboot中有休息服务并使用springdoc-openapi,我所有的端点都使用同一个类响应,如下所示:

在“列表”字段中,我添加了一个不同的bean列表,问题是当我使用springdocs生成yaml定义时,它只为所有端点生成以下模式:

任何人都知道如何使用我的 ListResponse 类为端点生成自定义模式,或者我应该为每个具有不同字段“list”的端点生成一个类吗?

0 投票
2 回答
5194 浏览

java - springdoc-openapi:如何添加 POST 请求的示例?

有以下Controller方法:

我需要找到一种如何在对象Swagger示例中显示的方法PagingAndSorting

我正在使用springdoc-apiv1.4.3。

0 投票
2 回答
2010 浏览

spring-boot - Springdoc - 如何将 externalDocs 添加到 OpenAPI swagger UI 自动生成的文档

所以我有一个 Spring Boot 项目,我刚刚添加了 OpenAPI Swagger UI。它会为我们所有的控制器和模型自动生成非常好的文档。但我想添加一些额外的配置,例如 externalDocs,如下所示。

但是由于它是自动生成的,所以我没有用于招摇的 YAML。我尝试了以下方法通过一个没有运气的 Bean 添加它。

如果需要,下面是我的 Pom.xml。

感谢您的任何建议。

0 投票
1 回答
317 浏览

swagger - 如何使用springdoc更改swagger授权屏幕上的文本

我想更改 swagger 授权 UI 屏幕上显示的文本。

我想将Authorized标签更改为Stored

请从 swagger UI 授权屏幕中找到以下屏幕截图

在此处输入图像描述

我想改变它的原因是错过领先。如果用户传递的凭据仍然无效,则它仍显示为已授权。

一旦我们执行请求,用户名和密码的实际验证就会发生。

一旦我们按下授权按钮,如果有人回答验证凭据,我也很好,如下所示。

Note: I am using Spring-boot, Spring security, and springdoc

在此处输入图像描述

任何想法或想法将不胜感激

谢谢 !!

0 投票
1 回答
5347 浏览

java - Swagger OpenAPI 3.0 - Springdoc - GroupedOpenApi 在 Spring MVC 中不起作用

我的应用程序是 Sping MVC 无法启动。

我正在使用 springdoc-openapi-ui 1.4.4

此外,我将以下导入添加到我的 @configuration 类之一;

并如下实现bean

但是当我尝试http://localhost:8080/MyApp/v3/api-docs/user

给我404。

但我得到了列出的所有 APIhttp://localhost:8080/MyApp/v3/api-docs

它也进来了http://www.onlykalu.com:81/MyApp/swagger-ui/index.html?configUrl=/MyApp/v3/api-docs/swagger-config

也没有定义下拉。

如果我添加

到 application.properties 然后我得到

在此处输入图像描述

我做错了什么?

我是否需要导入任何其他类才能使组功能正常工作?

谢谢

0 投票
2 回答
6093 浏览

spring-boot - springdoc-openapi-ui 将 header 参数添加到生成的 swagger

在我的 springboot 应用程序中,我有端点,这些端点由我的 springboot 应用程序中的 header 参数验证。当前的招摇 json 看起来像这样:

我想使用springdoc-openapi-ui配置添加缺少的参数,所以它看起来像这样:

我尝试通过将各种路径的通用参数添加到我的appplication.yml解决方案中来实现这一点

但它不起作用。

我的问题:

  1. 有没有办法使用应用程序配置修改我的招摇结果?
  2. 我想定义参数模板并将其添加到所有端点,我该如何实现?
0 投票
1 回答
802 浏览

springdoc - 具有多个 api-docs 的 Springdoc

我想在一个 swagger-ui 中组合三个 API 文档。我使用 Springdoc。三个 API 文档中的每一个都有自己的 url。(他们不在同一个项目中)。有没有办法做到这一点?

编辑:它现在以这种方式工作:

0 投票
1 回答
412 浏览

spring-boot - Springdoc-ui + GraalVM 原生 @Configuration 类问题

为了追求学习 GraalVM + SpringBoot 的细节,我正在开发一个示例应用程序,其中只有一小部分操作和功能。其中之一是公开 SpringDoc 端点的可能性(当前使用版本 1.4.5)。即使应用程序已正确编译并且本机映像可执行文件启动,它也会在开始配置内容时引发异常:

我已经有以下依赖项:

还有@SpringBootApplication(proxyBeanMethods = false)我的主要课程。

对于没有 proxyBeanMethods=false 属性的 @Configuration 类的这些情况,是否有任何解决方法?

更新:似乎在 Springdoc 1.4.6-Snapshot 上更新了配置。然而,其他的事情开始抱怨:

现在不知道该去哪里...

0 投票
1 回答
1922 浏览

spring-boot - Spring boot @project.version@ ​​变量不适用于 openApi

我尝试在 openApi 1.4.3 中使用来自 swagger-ui 2.5.0 的旧代码,

目前,当我运行我的网络服务时,它失败了,没有错误,经过多次调试,我注意到 openApi 不接受语法 @project.version@ ​​!

我使用这种语法从 pom.xml 中获取 spring boot 项目版本。此语法在 swagger 2.5.0 中有效,而在 2.9.2 中无效。

我正在使用 yml 文件。

你有想法吗?

先感谢您。