问题标签 [springdoc]

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

spring-boot - Springdoc 允许使用 Spring Security 对 rest 控制器进行身份验证访问

我的项目中有 Spring Security,它需要通过springdoc version 1.4.3. 我的要求是能够在身份验证后从 swagger-ui.html 获得响应。目前我可以看到 swagger-ui.html 页面,但在身份验证调用任何休息控制器时都会出现访问错误。我的要求是我应该能够在用户通过身份验证后从我的控制器获取数据。

这是一个生成的示例 curl url,它适用于cmd但不适用于 swagger-ui.html

0 投票
1 回答
1059 浏览

spring-boot - 基于 Open API 3 继承的不同示例

我想在 Swagger 中为父属性制作不同的示例。有什么简单的方法可以实现这一目标吗?

SampleA 的示例是

  • 下一个:abc.com
  • 上一个:abc.com?page=2

SampleB 的例子是

  • 下一个:xyz.com
  • 上一篇:xyz.com?page=2
0 投票
1 回答
824 浏览

springdoc - 如何在 Springdoc Swagger v3 中表示字符串列表?

下面是一个类似于我的情况的代码

如何指定从端点返回的用户列表ApiResponse()

请注意,Open-API-Definition 不是项目的一部分,而是在另一个项目中指定的。

0 投票
2 回答
531 浏览

spring-mvc - 在 Springdoc 中表示表单数据和返回字节数组的问题

我有以下一段代码,

以下是预期和实际结果。 预期与实际

我如何达到预期的效果?预期结果来自 Springfox。

0 投票
2 回答
734 浏览

spring-boot - 当我在 swagger-ui.html 中单击“试用”时,X-Forwarded-For 未出现

我有一个使用 springdoc 的示例 github:https ://github.com/vmisra2018/sb-example-swaggerdoc 我不知道如何为任何 api 启用 X-Forwarded-For 例如:“/person” 当我点击试用

重现行为的重现 步骤:

spring-boot 的版本=> 2.2.2.RELEASE

springdoc-openapi 的模块和版本 => springdoc-openapi-ui:1.2.32

我根据https://springdoc.org/faq.html有以下条目,并且还定义了 ForwardedHeaderFilter bean,

示例代码: https ://github.com/vmisra2018/sb-example-swaggerdoc

预期的行为 当我单击 swagger-ui.html 中的 try-it-out 时,我希望看到 X-Forwarded-For 标头。我没看到。

0 投票
1 回答
2489 浏览

spring-boot - 如何添加“授权:承载" 在使用 Springdoc Open API 3 Spec 的 OAuth2 隐式流的标头中

我正在从 Springfox 迁移到 Springdoc Open Api 3,并且正在尝试实现身份验证流程:

目前,我已经实现了一个隐式的身份验证流程。如下所示:

现在,问题是,我正确地被重定向到 Keycloak 服务器并且身份验证按预期工作,但是当我尝试从 Swagger UI 执行请求时,请求Authorization:Bearer <token>中丢失了。

我尝试了多种解决方案,例如在端点上添加安全方案要求,但它不起作用。我错过了什么吗?还是我的实施流程有误?我在发送到后端的每个请求中都需要 Bearer 令牌。

0 投票
1 回答
1060 浏览

spring-boot - 如何将 Spring Pageable 传递给 FeignClient

正如我在这个问题中所写:https ://github.com/spring-cloud/spring-cloud-openfeign/issues/375 和这个 SO 问题中: Spring data Pageable does not work with feign client

在包含 @requestbody 元素的 POST 请求中发送 Pageable 对象时遇到一些问题。

首先,我尝试发送嵌入在我的 RequestBody 中的 Pageable,因为它是在使用 springdoc-openapi-webmvc-core 时作为示例生成的。

例子:

不,我了解到,我也可以通过 Query 参数发送它,它将被解析。将可分页提取到 QueryParams 中的注解在 SpringDoc 中称为 org.springdoc.api.annotations.ParameterObject。

当我尝试通过 feign 调用类似的控制器接口时,就像这个客户端接口:

应用程序不会启动,因为该方法“有太多的身体参数”。我试图用 @RequestParam 注释 Pageable 但它不会被识别/解析。

我的问题是:

我们可以使用自定义的 AnnotatedParameterProcessor 例如 @ParameterObject 将 ParameterObject 扁平化并将其编码为 url 查询参数吗?

你会怎么做?还是 AnnotatedParameterProcessor 方法不对?我可能需要扩展器或其他东西吗?

0 投票
4 回答
10530 浏览

swagger-ui - 在 SpringDoc OpenAPi 中未禁用 petstore URL

我正在使用SpringDoc 1.4.3招摇。
我添加了以下配置以禁用petstoreURLapplication.yml

配置

但是当我在探索文本框中点击https://petstore.swagger.io/v2/swagger.json时,它仍然向我显示 petsore URL,如下图所示。

大摇大摆的形象

大摇大摆的形象

0 投票
1 回答
4128 浏览

java - Spring Doc swagger API 上的日期格式时间

我正在尝试使用 spring doc 从我的 springboot 应用程序生成文档,这是导致我出现问题的类的一些属性:

使用 Spring doc 注释,我大摇大摆地得到了这个:

dateOfBirth* 字符串($日期时间)

“出生日期”:“2020-04-29T14:15:32.475Z”

虽然我想要这个:

dateOfBirth* 字符串($date)

“出生日期”:“2020-04-29”

怎么做?我认为接近解决方案,但我无法弄清楚我所缺少的

0 投票
1 回答
58 浏览

swagger - 如何记录我没有所有权的对象?

我正在返回一个Page<SomeObject>在我的方法端点中。在我的 OpenAPI UI 中,如何生成来自org.springframework.data.domain.Page类型的字段的描述。通常我所做的是转到我想要记录的对象并用@Schema(description = "some description"). 但是我无法访问该Page课程。我如何记录它的字段?

我可能在这里遗漏了一些简单的东西,但我们将不胜感激。

PS:我正在使用 OpenAPI v3 和 springdoc