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

spring-boot - springdoc-openapi 中的隐藏参数不起作用

我有 2.3.0 版的 Spring Boot 应用程序。和 1.4.1 版中的 springdoc-openapi-webflux-ui。

我在这样的操作中注释了参数。

使用hidden = true我希望这个参数在 swagger-ui 中不可见。但它是。我误解了这个参数还是它没有做它应该做的事情?

我希望此参数位于 api-docs 中,以生成能够使用此参数的客户端,但我希望它在 swagger-ui 中不可见

0 投票
1 回答
24 浏览

springdoc - 如何设置 OAuth2.0 请求标头

我想在 SpringDoc Swagger 页面上放置一个值,如邮递员,并将其应用于所有请求

邮差

招摇-ui

并且预计 swagger 不会弹出用户名和密码的输入弹出窗口。

感谢所有的答案。

0 投票
3 回答
2980 浏览

spring - springdoc-openapi 在没有服务器的情况下生成 openapi yaml

我有一个 Spring Boot Gradle 项目,我想获取它的 OpenAPI 规范 YAML 文件。

据我了解,官方swagger-core不支持 Spring boot 项目,因此我发现springdoc-openapihttps://github.com/springdoc/springdoc-openapi-gradle-plugin)。

似乎为了获取 YAML/JSON 文件,在运行generateOpenApiDocs任务时,springdoc库设置了一个带有一些端点 (/v3/api-docs) 的服务器来下载文件。

  1. 我正在使用默认配置,由于某种原因,我不断收到以下错误:

任务“generateOpenApiDocs”执行失败。无法连接到 http://localhost:8080/v3/api-docs 等待了 30 秒

似乎由于某种原因它没有设置服务器。我该如何解决?

  1. 是否可以跳过服务器部分?我可以将 springdoc 配置为在构建时简单地生成文件吗?
0 投票
2 回答
3199 浏览

spring-boot - OpenApi - 有没有办法在使用 springdoc-openapi-maven-plugin 生成的合同中使用带有鉴别器部分的 ComposedSchema?

我有一个具有以下功能的示例 SpringBoot API:

  • 1 个控制器,可通过 GET 请求公开可调用的单个端点并返回自定义类(在我的示例中为 ContainerClass)
  • ContainerClass 包含一个属性 List
  • ParentClass 是一个抽象类,有 2 个子类:ChildA 和 ChildB

我尝试使用springdoc-openapi-maven-plugin从此 API 生成 OpenApi 合同。

在我的 pom.xml 中,我有以下元素:

  • SpringBoot 版本:2.2.6
  • org.springdoc:springdoc-openapi-ui:1.4.1
  • org.springdoc:springdoc-openapi-maven-plugin:1.0

这是我从中生成模式的类。

当我运行 springdoc-openapi-maven-plugin 时,我得到以下合同文件。

实际上,在我的上下文中,为了不对现有消费者进行任何重大更改,我需要ContainerClass模式中的items属性来包含ParentClass模式中包含的鉴别器部分,如下所示:

当我尝试在注释中设置属性时,我无法做到这一点。当我调试io.swagger.v3.core.jackson.ModelResolver的代码时,我无法找到一种方法来做到这一点。到目前为止,我还没有找到对我有帮助的代码示例。

有没有办法让 ComposedSchema (在我的例子中包含在ContainerClass中的数组)具有由 springdoc-openapi-maven-plugin 执行生成的鉴别器部分

0 投票
1 回答
449 浏览

spring-boot - Springdoc 与多模块 gradle

我正在尝试在多模块 gradle 项目中使用 Springdoc,但我无法使其工作。有人已经做过类似的事情了吗?

我的 Gradle 项目结构如下所示:
我的项​​目

  • 应用
  • 模块1
    • api
    • 领域
    • 存储库
  • 模块2
    • 与模块1相同

Application 模块依赖于每个模块项目,并且 implementation group: 'org.springframework.boot', name: 'spring-boot-starter', version: springBootVersion

在 API 子模块上有:
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: springStarterWeb
implementation group: 'org.springdoc', name: 'springdoc-openapi-ui', version: '1.4.2'

0 投票
1 回答
335 浏览

spring-boot - SpringDoc (spring boot) utf-8 json 标头响应文档

我正在使用 springdoc(springdoc-openapi-ui)作为 kotlin spring boot 应用程序(Gradle build)的其余文档,我想知道是否有办法将响应标头内容类型编码设置为 utf-8。默认返回的内容类型为: Content-Type: application/json;charset=ISO-8859-1

问候。

0 投票
1 回答
1289 浏览

java - 如何为请求参数允许多个预定义(枚举)值?

我想接收查询字符串参数的多个值,例如:

同时将允许的值限制为预定义的集合。

我已经找到了如何限制允许的值,现在如何允许输入多个值?

这是我当前的代码:

如果我删除 @Parameter 注释,swagger-ui 会显示一个“添加项目”按钮。

0 投票
1 回答
1481 浏览

kotlin - springdoc-openapi:如何在 coRouter DSL 中使用 @RouterOperation

我将 springdoc-openapi 与 Kotlin 和 WebFlux.fn 一起使用。
我想在 CoRouterFunctionDsl 的每个路径上使用 @RouterOperation 注释,但我做不到。

似乎没有任何相关文档。
如何在 coRouter DSL 中使用 @RouterOperation?

0 投票
1 回答
274 浏览

springdoc - 使用 Springdoc 在启动时将 SwaggerUI 路径/url 打印到控制台

使用 springdoc 时,是否有一种可靠的方法可以在启动时将 SwaggerUI 路径打印到控制台?

我正在寻找一种对springdoc.swagger-ui.enabledand的配置更改具有鲁棒性的方法springdoc.swagger-ui.path。感觉这应该可以通过没有大量自定义代码的框架来解决。

0 投票
1 回答
516 浏览

java - SpringDoc WebMvc 与 WebFlux

我将 SpringDoc Open Api 3 用于我的其余 API。现在我正在使用 WebMvc 版本。切换到 WebFlux 版本有什么好处吗?除了异步会发生在客户端之外,在客户端使用 WebClient (或其他一些异步客户端)不会是一回事吗?归根结底,Rest 方法可以在内部使用异步方法,但尝试看看是否值得将公开的方法迁移到 WebFlux。