问题标签 [springdoc-openui]

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

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

这是我的自定义 DTO 类

我正在使用 SpringDoc 并尝试以编程方式将模式添加到 OpenApi，但没有成功。

mySchema 的描述未添加到我在生成的 YAML 文件中看到的模式列表中，如果我尝试引用它：

swagger UI 中显示以下错误：

路径解析器错误。/XX/v1/test/status/{entry}.get.responses.404.headers.XxX.$ref 无法解析引用：无法解析指针：/components/schemas/MySchema

拜托，你能帮我理解吗？

编辑：我正在使用版本1.3.9

我最近将 swagger UI 从 更改Springfox为SpringDoc OpenApi.

Swagger 在Chrome.

但是在Internet Explore我遇到错误时。My IE version is 11

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

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

PS：我正在使用 OpenAPI v3 和 springdoc

我spring boot 2.3.2.RELEASE与spring-cloud-config-server 2.2.4.RELEASE. 我试图spring-doc-openapi (1.4.3)在现有项目中实施。如果我添加@EnableConfigServer一个配置类文件，swagger-ui.html端点会返回一个奇怪的 json：

而不是预期的招摇用户界面。我不确定它是否是一个错误，但希望能提供任何帮助。

我有一个招摇的 API。端点示例：

我的招摇页面正确地向我显示了所有信息：

但是当我尝试生成一个 yaml 文档时，这个描述不起作用。我在我的 yaml 文档中没有看到端点的描述（返回 Pix 事务列表。）：

我正在使用 Swagger 来记录我的项目。我想从 springdoc 生成 YAML 文档。但是当我生成这个 YAML 文档时，YAML 没有我的 Swagger 文档评论。例如。我的项目中有一个端点：

当我打开我的招摇文档时，我可以看到正确的文档：

但是......当我生成我的 YAML 文档时，我在 YAML 文档中看不到我的评论（例如：“返回 Pix 钱包列表。”）。例如：

如何在我的 YAML 文档中添加我的 Swagger 评论？

我使用这个库生成文档：

我有这个控制器：

但我得到这个文件：

为什么required = false不起作用？

我试过这个：

它也不起作用

编辑：（@Helen 评论的答案）-我当然知道：

我试过这个：

它使文档变得更糟。所以我没有添加这段代码。看起来{"/test", "/test{hz}"}像这样：

使用此控制器定义，带有标签：

尝试自定义 OpenApi 时，无法获取标签的值：

openApi.getTags()总是返回null，我期待一个带有MyController标签的列表。

有什么建议吗？