问题标签 [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.
spring - 使用开放 API 配置的全局参数集?
我正在使用Spring Boot REST OpenAPI 3
规范。在此示例中,我希望在向每个端点发出请求时全局设置Custom-Header-Version=v1
要传递的标头 ()。
现在的问题是我有100 个 REST 端点,并且对于我需要继续添加的每个端点@Parameter(in = ParameterIn.HEADER .....
,这个配置,而不是我希望在全局范围内设置它。如果我们可以在 OpenAPI 中做到这一点,有什么办法吗?
有什么方法可以从 Spring doc ui 中删除 SmartBear 徽标?
java - springdoc-openapi 通用控制器类型参数支持
我有以下控制器代码:
问题:在 Swagger 中为 SpecificController 生成 open-api 标记时,响应中的客户端模型是 BaseClientModel,而不是 SpecificClientModel,并且只有 id 字段,没有 id+name。
实际的:
预期的:
鉴于我有 40 多个特定控制器,有什么方法可以让 springdoc open-api 基于特定的通用参数生成正确的标记?
spring - Open API 3 - 如何读取 Spring Boot 分页属性?
我正在使用 Spring Boot + Spring Rest Pagination + Open API 3。
因为我使用的是 Spring Boot 应用程序。我已经配置了以下配置,
有什么方法可以为 Open API 3 规范配置上述属性而不是硬编码?
springdoc - 如何更改 swagger-ui 的布局?
如何更改 swagger-ui 的布局?
对于布局选项,您可以使用 swagger-ui 配置选项。这是什么意思?
例如:
有哪些不同的选项可用?
springdoc - 将 GroupedOpenAPI 与 SpringDoc 一起使用时如何排除路径
我最近为 SpringDoc 淘汰了 SpringFox。
以前我能够排除用于 Swagger UI 的路径,如下所示:
在上述情况下,Swagger UI 将为 path3 和 path5 显示。
在使用 SpringDoc 时使用 GroupedOpenAPI,我只看到了一种明确设置应该允许哪些路径的方法,例如
我希望有一个更通用的方式,我可以指定哪些路径不允许,所以如果我添加更多路径,默认情况下它们将被允许。就像是:
不确定是否支持这样的功能。任何帮助,将不胜感激。谢谢你。
spring-boot - 如何生成 Map 类型的 RequestBody使用springdoc swagger open api 3.0?
对于上面的代码,只有 Parameterid
正在生成并且它完全缺少 requestBody。我根据https://swagger.io/docs/specification/data-models/dictionaries/添加了 type="object" 。
springdoc - 如何全局设置模型属性数据类型的实现类?
我想为某些数据类型全局设置一个实现类。例如,我们想停止在我们的模型中使用注释。在下面粘贴了一个示例。
我们可以使用配置 springdoc-openapi 来做到这一点吗?或者有没有办法将 Java Instant 映射到 OpenApi 日期时间格式?
openapi - 如何公开其他模型:从 Springfox 迁移到 Springdoc
我需要公开一些不直接在 REST API 方法中使用的模型。
使用 springfox,我使用 Docket 的additionalModels
方法以编程方式将模型添加到规范中:
如何用springdoc做到这一点?
我用 dummy-parameter 创建了一个虚拟操作,其中包括所有必需的模型。但我觉得这种方法有改进的空间。
java - 如何在 Java 中使用泛型制定 OpenAPI 规范
我在控制器中使用泛型。例如,从某些端点我返回Response<News>
和Response<Tag>
.
嗯,Swagger 会自动生成这部分 yaml
和
这是我在 Java 中的响应实体。
这就是 Swagger 生成组件的方式。
好吧,它几乎是重复的代码。我想避免它,只在我的端点描述中使用Response,并明确地向我的用户展示我使用泛型。
像这样的东西:
我已经准备好在没有 Swagger 的情况下手动完成它。有没有办法做到这一点,也许使用继承或多态?