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

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

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

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

实际输出

实际输出

预期产出

预期产出

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

解决方法

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

0 投票
1 回答
717 浏览

spring - 如何在 springdoc Schema 中描述标准 Spring 错误响应?

SpringBoot 应用程序在出现未处理错误时的默认服务器响应是

我想在应用程序路由的 Springdoc 注释中描述它。

假设有一个标准类DefaultErrorResponse(只是一个模拟名称),它可能如下所示:

在更糟糕的情况下,这样的类不存在,Spring 仅Map在后台使用 a 来创建此响应。然后这个注释会更详细,包括明确提及响应中包含的每个字段。

显然,对于大多数路线,这部分@ApiResponse(responseCode="500",...是相同的,减少重复会很好。

在文档中引入默认错误响应描述的正确方法是什么?

0 投票
1 回答
1172 浏览

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

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

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

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

知道有什么问题吗?

Springdoc v1.4.3

春季启动 2.x

0 投票
1 回答
110 浏览

java - 如何记录提供另一种类型(MyClass 与 String)的 Rest 参数?

在 Springfox 中,我曾经使用以下语法来渲染具有完整模型的 String 参数(原始 Github 问题):

这种表述的原因是,如果我将MyClass请求正文的类型作为类型,我无法区分属性何时未更新或何时设置为 null,因为两者都将被反序列化为 null 字段值。

我如何使用 Springdoc 做到这一点?

0 投票
2 回答
346 浏览

spring - @Value 不提供来自应用程序属性 Spring Boot 的值

我将 Springdoc 1.4 与 Spring-Boot 2.3 一起使用,在 OperationCustomizer 类中,我需要从应用程序属性文件中读取值。但每次该字段总是初始化为null. 规格如下

应用程序属性

OperationCustomizer 类

下面的代码正在调用该类

此处提供的方法有效,但我想要一种不必使字段静态的方法。

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

java - 是否可以配置 spring-openapi 以在 v3 api-docs 中生成可预测的订单输出?

在为 springdoc OpenAPI v3 api-docs 生成输出时,任何细微的变化都会导致在生成的 v3 api 文档中产生完全不同的顺序。

保持这个顺序可预测会很方便,特别是在使用.yaml输出时进行调试。因此,如果有人知道订购此产品的方法,我将不胜感激。

0 投票
2 回答
7328 浏览

java - springdoc-openapi-ui OAuth 2.0 授权代码流与 PKCE

我正在使用带有 springdoc-openapi-ui-1.4.3 的招摇

设置安全架构

安全配置

有依赖关系

配置设置

在 swagger UI 中,clientId 为空并且存在客户端密码,授权码 + PKCE 流客户端密码不应该存在

在此处输入图像描述

0 投票
2 回答
1345 浏览

swagger - 用于 Spring Data Rest 的 Swagger 2 或 3

我有一个使用弹簧数据休息的弹簧启动应用程序。我在使用 swagger 提供阅读良好的 API 文档时遇到问题。我尝试了 spring fox 和 springdoc,但每个都有它的问题

  1. 春狐:
  • 我无法更改存储库的标签名称,只能更改描述
  • 不支持预测
  • 尚不支持openAPI3(这其实不是什么大问题)
  1. Springdoc ( https://springdoc.org/ )
  • 我无法更改标签名称和描述(@Tag 不适用于 repos)
  • 不支持预测
  • 同一个仓库有 3 个标签,例如 books-entity-controller、books-search-controller(带有父类的方法)和 books-property-reference-controller(带有不必要的 /{id}/{property} url 列表)

有更好的办法吗?我喜欢 spring fox 不提供多个标签,而且自动生成的标签名称更好,例如 Books Entity 而不是 books-entity-controller。但最好是定制它或找到更好的替代方案。

0 投票
1 回答
1324 浏览

java - 如何在 swagger @Operation 中描述 multipart-form-data?

有一个请求主体类型为 的端点MULTIPART-FORM-DATA,包含三个字段:

  1. “我的附件” -required类型字段File
  2. “选项” -required任何类型的字段(FileText
  3. "note" -optional类型字段Text

使用 java 注释在 Springdoc(或 Swagger v3)中描述此请求正文的正确方法是什么?

我认为这@Operation是有资格的,但找不到任何合适的方式来使用它。

io.swagger.core.v3 - version 2.1.3