问题标签 [springdoc-openapi-ui]

带有 springdoc-openapi-ui (Swagger UI) 的 Spring Boot 2.2 应用程序运行 HTTP 端口。应用程序部署到 Kubernetes，Ingress 将 HTTPS 请求从集群外部路由到服务。

在这种情况下，可用的 Swagger UIhttps://example.com/api/swagger-ui.html有错误的“生成的服务器 url” - http://example.com/api。虽然它应该是https://example.com/api。

虽然 Swagger UI 通过 HTTPS 访问，但生成的服务器 URL 仍然使用 HTTP。

我正在尝试为我的 API 中的所有端点添加一个默认错误模型，以获取一些错误代码。

我通过阅读以下问题找到了部分解决方案：

• Springfox -> Springdoc：如何公开附加模型
• https://github.com/springdoc/springdoc-openapi/issues/381

这是我为该定制创建的 bean：

我的错误类看起来像：

问题是，当我在 swagger-ui 中打开端点定义之一时，我收到以下错误：

Could not resolve reference: Could not resolve pointer: /components/schemas/ErrorItem does not exist in document

如何定义 ErrorItem 的架构，使其可用于 swagger-ui？

我在用：

• Spring Boot => 2.2.4.Release
• springdoc-openapi-ui => 1.3.0
• springdoc-openapi-security => 1.3.0

我正在Spring Boot & Open API Spec3使用springdoc-openapi-ui. 如何显示下拉菜单或从多个输入中选择输入的方式？我浏览了https://github.com/swagger-api/swagger-ui/issues/685，我需要这样的东西。

我的组织只允许 8 个查询参数，我们使用分页，所以page, size, sort (by multiple fields) 和 order (multiple fields)。这一切都消耗 4 个查询参数，只剩下 4 个可用，因为对于少数端点，消费者希望使用许多参数作为可选参数来获取数据。

如果我能以某种方式api-doc创建选项来选择分页和排序等多项内容，那就太好了。

同样的问题已经在这里打开：https ://github.com/springdoc/springdoc-openapi/issues/535

Springdoc 团队必须不断地寻找和解决问题。谢谢！

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

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

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

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

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

我正在使用Spring Boot v2.2.2.RELEASE和springdoc-openapi-ui V1.2.30。

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

我正在尝试将 swagger 文档添加到我的项目中。我需要为 Sample.class 的@RequestBody 中的@Parameter 添加多个示例，以下代码是文档中提到的编写方式。

正在生成的 yaml 输出如下：

这似乎缺少应该按照代码添加的示例

我有一个现有的 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 中的错误修复和增强功能的任何建议？

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

我有以下 JSON：

映射到以下 Java 类：

当我转到/v3/api-docs（或/swagger-ui.html）时，会生成以下文档：

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

我想生成以下文档：

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

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

前任 ：

谢谢

可以为此使用注释吗？我不明白如何使用 Yaml。

例子：

ItemsDto:

文章：

https://swagger.io/docs/specification/data-models/dictionaries/ 自由格式对象“如果字典值可以是任何类型（又名自由格式对象），请使用附加属性：真：”

我将尝试在 @Schema 注释中使用 'ref = myfile.yaml' 属性