问题标签 [springdoc]

我正在从 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中完成的

谢谢

我正在使用 Kotlin 开发 Spring Boot。现在我想创建 API 文档，但是它们的注释很笨拙而且罗嗦。

当前的：

我想要的看起来像：

我可以用一些东西来存档吗？一些想法是预处理和类型别名。

使用默认的 springdoc 配置为我的 Spring Boot 应用程序生成招摇。我们在 api 请求和响应中使用“is”前缀 pro 布尔属性，但在生成的 api 文档中没有“is”前缀。

例子：

昂首阔步：

是否有任何配置不忽略springdoc的“is”前缀？

感谢您的任何回复

我有一个简单的问题：我刚刚开始使用 Open API 3。为此，我在 Maven 中添加了以下依赖项。

添加此依赖项后，我是否可以通过 localhost:8082/v3/api-docs 访问服务而无需事先设置任何内容并调用依赖项的函数？这怎么可能发生？这背后的概念是什么？

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

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

http://localhost:8080/doc.html

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

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

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

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

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

我正在使用最新版本（1.3.0）的springdoc-openapi。现在我想按“名称”属性对 UI 中的标签进行排序。

我知道“springdoc.swagger-ui.tagsSorter”配置，并且我可以使用自定义排序器功能。但我找不到函数应该是什么样子的例子。

我尝试了以下似乎不起作用的方法：

springdoc.swagger-ui.tagsSorter=(a, b) => a.get("name").localeCompare(b.get("name"))

我正在使用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 中查看实际查询参数？货币，它看起来像身体。

我正在尝试为我的 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

我有一个要求，我需要在我的微服务中有一个返回文档的 GET 端点，我io.swagger.v3.oas.models.OpenAPI想知道如何编写该对象。原始形式的对象如下所示：

我试过这个，但文件刚刚出现空/空白：

我已经阅读了有关 springfox 的信息，但是他们文档中的示例不是很清楚……我想知道这是否有必要。我在这个构建器上做错了什么？

顺便说一句，使用 Gradle

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