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

springdoc - Springdoc-openapi - 有没有办法在 POST 请求中将默认值覆盖为 null 或空?

我正在使用 Spring Boot 和 Open API 3。当我发出 POST 请求时,通过 OAS2 Swagger,我看到所有 String 字段都作为 Spring 的默认值出现,我看不到通过 SpringDoc Open UI 或通过 SpringDoc Open UI 删除它的方法代码。

在这里,消费者在发出请求时不愿意从字段中删除字符串。有没有什么办法

1)如果我们可以删除“字符串”作为一个值并将 null 或“”设置为默认值?2)如果我们可以读取自定义对象并将找到“字符串”的所有值重置为null,有什么办法吗?

0 投票
1 回答
712 浏览

spring - Springdoc Open API UI - BaseLayout 不起作用

在提出问题之前,我经历了:https : //springdoc.org/springdoc-properties.html#springdoc-openapi-core-properties,但看起来事情不正常。

我想使用 BaseLayout 并且还想将 Open API Specification 响应的主题更改为黑色。

我正在使用Spring Boot v2.2.2.RELEASEspringdoc-openapi-ui V1.2.30

即使进行了上述配置,默认配置也不会生效。

0 投票
1 回答
2640 浏览

java - springdoc-openapi 不同的例子

我使用 springdoc-openapi 来记录我的 REST API。错误对象返回一个错误,该对象具有errorCodemessage。我使用@Schema注释来记录一个例子。但是,对于不同的错误,我需要不同的示例。有没有办法,怎么做?

我的代码示例:

0 投票
1 回答
880 浏览

spring - 是否可以从 Intellij IDE 访问 Spring 文档?

我想通过 Intellj 的View->Quick Documentation功能查看 Spring 文档。为此,我通过使用外部文档链接尝试了以下操作:

好的,我已经添加了 Spring Framework 文档的 url。按照指示,但是,当我在 Spring Framework 项目上执行 ctrl+Q 时,它没有显示任何文档。在上面的弹出窗口中...

这是我使用的网址:https ://docs.spring.io/spring-framework/docs/current/javadoc-api/

Intellij 支持

但它不起作用。

有人可以帮忙吗?

0 投票
1 回答
2759 浏览

compatibility - springdoc-openapi + Spring 4 兼容性

我有一个现有的 Spring 4 API 并已成功集成 springdoc-openapi 以在 JSON/YAML 中生成 OpenAPI 3 规范,并使用 springdoc-openapi 1.2.29 和 Spring Boot 15.2.2.RELEASE 显示 Swagger UI,但是似乎是在 springdoc-openapi 的更高版本中修复和增强的各种错误。不幸的是,如果我使用高于 springdoc-openapi 1.2.29 的版本,我会遇到与 Spring 4 的各种兼容性问题。

springdoc-openapi 和 Spring 4 是否有可用性兼容性矩阵?当我阅读 springdoc-openapi 文档时,我没有看到任何自述文件或发行说明表明存在 Spring 5 要求,但是如下所述,一旦您达到某个版本,就会在基础 springdoc-openapi 中使用 Spring 5 类。

我的相关POM:

当使用 springdoc-openapi-ui 1.2.30 时,它随后会引入 springdoc-openapi-common-1.2.30.jar,它会在尝试使用 org.springframework.http.codec.multipart.FilePart 时抛出异常。同样,使用 1.2.34 或更高版本将在 MethodParameter.getParameter() 上引发异常。

Spring 5 参考: https ://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/codec/multipart/FilePart.html

有关如何解决此问题以在更高版本中利用 springdoc-openapi 中的错误修复和增强功能的任何建议?

0 投票
1 回答
274 浏览

header - Springdoc:排除某些端点的自定义全局标头参数

如果我创建了一个 OperationCustomizer,它将一个新的全局自定义标头参数添加到所有端点,我该如何为一小部分不适用的端点添加一个排除列表?

0 投票
1 回答
1756 浏览

swagger - 如何使用springdoc-openapi / swagger生成映射到json对象的类型的可为空字段?

首先,以下存储库包含重现此问题的所有代码(以及描述):https ://github.com/elgleidson/swagger-problem

我有以下 JSON:

映射到以下 Java 类:

当我转到/v3/api-docs(或/swagger-ui.html)时,会生成以下文档:

如您所见,对于类型未映射到object文档的字段,按预期生成。同样的情况不会发生nullableObjectFieldnullable属性被放入MyClass定义而不是字段。

我想生成以下文档:

我怎样才能做到这一点?可能吗?

0 投票
1 回答
1253 浏览

spring - 将 Actuator 添加为 groupedOpenApi

我们可以将 Actuator 端点添加为一个 groupedOpenApi 吗?

前任 :

谢谢

0 投票
2 回答
1331 浏览

springdoc - 我们可以在 Springdoc 中用 redoc 替换 swagger-ui

我正在尝试用 Springdoc 替换手动维护的 swagger 文件。目前,我们使用ReDoc来渲染文件,因为它们支持discriminator.

swagger-ui有没有一种直接的方法来替换/取代嵌入式ReDoc

0 投票
1 回答
253 浏览

spring-boot - 如何自定义和覆盖 POJO 中的参数值?

我正在研究 Spring Boot v2.2.6.RELEASE 和 Open API 集成示例。此示例具有使用 20 个不同参数进行搜索的能力。所以这个 POJO 类拥有CustomSearchDto这 20 个不同的值。

在 POJO 中我使用了 orgName,但@parameter(in = ParameterIn.QUERY, name = "orgizationName",不知何故我想覆盖变量名。我必须这样做。有什么办法吗?

这是我的自定义 DTO 类