问题标签 [springdoc-openui]

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

spring - 在 Spring Boot REST Open API 3 中保持相同的 URL 但合同更改?

我正在使用Spring Boot and REST and Open API 3实现。在这个例子中,v1Group 有 List 实现——所有数据都将进入 List,v2Group 中有分页实现——所有数据将以页面的形式出现。

对于消费者,我们不想更改端点 url 以供他们使用。

返回列表的端点。

分页端点

我希望 V1 端点显示在中,GroupedOpenApi而 v2 端点显示在GroupedOpenApi2. 有什么建议么 ?

0 投票
1 回答
4159 浏览

spring-boot - 如何使用springdoc在swagger openapi规范3.0的@RequestBody中创建多个模式?

我有下面的 api,我需要有两个内容类型的参数,application/x-www-form-urlencoded因此我使用@RequestBody 而不是@Parameter

我需要 swagger.json 类似于下面的示例,但我不知道如何使用 springdoc 生成它。我也尝试了@ArraySchema,但我没有得到我需要的输出。我在语法上犯了一些错误,无法在线找到示例。

非常感谢任何帮助。TIA

0 投票
1 回答
1493 浏览

spring-boot - 如何生成 Map 类型的 RequestBody使用springdoc swagger open api 3.0?

对于上面的代码,只有 Parameterid正在生成并且它完全缺少 requestBody。我根据https://swagger.io/docs/specification/data-models/dictionaries/添加了 type="object" 。

0 投票
1 回答
3438 浏览

spring-boot - 如何使用 springdoc openapi 在 swagger ui 上有条件地忽略 PathVariable

我正在从 springfox 2.9.0 迁移到 springdoc-openapi-ui 1.2.33。我需要根据条件在 swagger ui 上显示或隐藏 PathVariable。我有两条路径,如下所示

  1. 字符串名称标识符 = "{fisrtName}/{lastName}"

  2. 字符串名称标识符 = "{fisrtName}"

我根据要求传递了上述名称标识符之一。

我对上述路径使用单个控制器,如下所示

docket.ignoredParameterTypes(IgnoreLastName.class)在 springfox 中,我可以使用如下所示的方法来实现它。

但是在springdoc open api中我无法实现相同的目标。您的帮助同样受到赞赏。编码是在java中完成的

谢谢

0 投票
1 回答
221 浏览

spring - 无法访问 spring-docs-open-ui 招摇文档

我是一名春季新手,试图为我的 Spring Boot 应用程序配置 swagger 文档。我根据此处提供的文档配置了我的应用程序

我可以从此 URL 本地访问文档页面

http://localhost:8080/doc.html

但是,当我在 Docker 上部署我的应用程序时,我不断收到 404 状态。

https://www.mywebsite.com/context_path/doc.html

我的 application.properties 文件如下所示 -

我还添加了一个重定向到文档页面的 HomeController

仅供参考,我正在使用 Amazon Cognito。我已经阅读并尝试了几个我在网上找到的例子,但我无法做到这一点。有人能帮我吗?

0 投票
1 回答
5271 浏览

spring - Spring docs - Open API 3 - 如何将默认值设置为正文?

我正在使用Spring Boot + Spring Data Mongo + Spring REST + Spring HATEOAS来实现 REST 端点。

由于我们传递了超过 5 个查询参数(组织的专有设置,应该不传递),所以我想创建一个 EmployeeDto 类并将该类传递给控制器

它显示的 Swagger UI 像 -

卷曲命令:

curl -X GET " http://localhost:8080/employee-data/employees/geographies?firstName=string&lastName=string&age=0&languageCd=string&isActive=string&email=string®ionCd=string&page=0&size=25&sort=firstName&order=ASC " -H " 接受:应用程序/json"

EmployeeDto.java

我在寻找 -

1)如何为每个字段设置默认值,而不是看起来默认的“字符串”?

2) 如何简单地允许在 OAS3 UI 中查看实际查询参数?货币,它看起来像身体。

0 投票
1 回答
2921 浏览

spring - Open API Spec3 - 如何显示下拉菜单或从多个输入中选择输入的方式?

我正在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 团队必须不断地寻找和解决问题。谢谢!

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 回答
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 吗?

前任 :

谢谢