嵌套复杂类型中的SpringDoc swagger文档生成异常
是指在使用SpringDoc框架生成API文档时，遇到了嵌套复杂类型导致文档生成异常的问题。
嵌套复杂类型是指在API接口的请求参数或响应体中，存在多层嵌套的数据结构，例如对象中包含了列表、列表中包含了对象等等。当使用SpringDoc框架生成API文档时，由于嵌套复杂类型的存在，可能会导致文档生成异常，无法正确展示嵌套复杂类型的结构和字段信息。
为了解决这个问题，可以采取以下几种方法：
- 使用@Schema注解：在嵌套复杂类型的字段上使用@Schema注解，手动指定字段的描述信息、类型等。这样可以帮助SpringDoc框架正确解析嵌套复杂类型，并生成准确的API文档。
- 使用自定义对象：将嵌套复杂类型抽象成自定义的对象，并在API接口中使用该对象作为请求参数或响应体。通过使用自定义对象，可以简化嵌套复杂类型的结构，使其更易于生成API文档。
- 使用泛型：如果嵌套复杂类型是通过泛型实现的，可以在API接口中使用泛型来表示嵌套复杂类型。SpringDoc框架对泛型的支持较好，可以正确解析泛型类型，并生成准确的API文档。
总结起来，解决嵌套复杂类型中的SpringDoc swagger文档生成异常可以通过使用@Schema注解、自定义对象或泛型来处理。这些方法可以帮助SpringDoc框架正确解析嵌套复杂类型，并生成准确的API文档。
腾讯云相关产品中，与API文档生成相关的产品是腾讯云API网关（API Gateway）。腾讯云API网关提供了丰富的功能，包括API文档自动生成、请求转发、鉴权、流量控制等，可以帮助开发者快速构建和管理API接口。更多关于腾讯云API网关的信息，请参考腾讯云官方文档：腾讯云API网关产品介绍。
相关·内容
在我的春季引导应用程序中，在应用程序启动时，我正在生成多个json格式的swagger文档，并存储在位置-静态/标记文件。我能够通过在application.properties中提到路径来读取文件，如下所示
application.properties
springdoc.swagger-ui.urls[0].url=/swaggerdoc/openapi.json
springdoc.swagger-ui.urls[0].name=openapi
springdoc.swagger-ui.urls[1].url=/swaggerdoc/openapi1.json
springdoc.sw
浏览 6提问于2022-01-26得票数 1
回答已采纳
我指的是spring提供的演示中的代码示例为和，下面是代码示例。
springdoc.version= @springdoc.version@
springdoc.swagger-ui.use-root-path=true
springdoc:
version: '@springdoc.version@'
swagger-ui:
use-root-path: true
我想了解提到@springdoc.verison@和${springdoc.version}的方式之间的区别。在yaml文件中使用它的标准是什么？
浏览 4提问于2021-06-02得票数 0
回答已采纳
目前，我正在从事一个使用spring功能web编程的项目。我通常在restController中使用swagger 2的注解，但是用函数式的web编程，我找不到哪里！告诉应用程序搜索端点(比如目录中的basepackage )并在html页面中加载swagger的位置。这是我的代码：
@Configuration
public class RouterClient{
@Bean
public RouterFunction<ServerResponse> routes(ClientHandler client){
return route(GET("/api/clien
浏览 0提问于2020-02-28得票数 5
回答已采纳
将springdoc依赖项添加到我的Spring项目(而不是springdoc)之后，将生成OpenAPI V3文档，并可以使用默认的swagger页面：localhost:8080/swagger-ui.html查看文档。因为springdoc文档取代了以前的Swagger文档，所以我希望在相同的URL localhost:8080/docs/index.html中提供它。根据springdoc文档，我认为可以在application.properties中使用application.properties选项来完成
springdoc.swagger-ui.path=/docs/index.
浏览 3提问于2021-07-21得票数 2
2回答
我正在使用swagger运行一个sprinboot应用程序。我只是遵循了一个教程，原则上它只需要在我的pom.xml中包含springdoc就可以在本地工作。
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.5</version>
<!--<version>1.2.32</version>-
浏览 3提问于2021-03-15得票数 0
org.springdoc-openapi-ui版本= 1.5.13使用Maven 4.0.0，java 11
user.java模型
@Entity(name = "User")
@Table(name = "User")
public class User {
@Id
@GeneratedValue(strategy=GenerationType.AUTO)
private Integer id;
@Column
@NotBlank(message = "user last name cannot be bl
浏览 16提问于2022-01-10得票数 0
回答已采纳
1回答
我有一个springdoc应用程序，它使用支持Swagger。对于我来说，我无法让生成的Swagger实际发布JSON。相反，前端将args作为请求参数传递。如何让Swagger真正提交JSON？
@Data
public static class SampleData {
private String info;
}
@PostMapping(value = "/test", consumes = "application/json")
public void postData(@ParameterObject @Reques
浏览 8提问于2022-01-28得票数 3
回答已采纳
1回答
这不是关于springfox的故事，而是springdoc -openapi的故事。
我现在的依赖
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.3</version>
</dependency>
我的财产
springdoc.swag
浏览 7提问于2022-01-26得票数 0
我正在尝试通过gradle插件测试openapi代码生成器。所以，我有一个包含文档的.yml文件(在中运行它，看起来很酷)
openapi: 3.0.2
info:
title: Testing docs
version: 1.0.0
tags:
- name: Registration
paths:
/registration:
post:
tags:
- Registration
summary: Register user
...
这是我的build.gradle的一部分
plugins {
id "org.
浏览 18提问于2021-02-19得票数 0
回答已采纳
使用Open API 3时如何设置自定义头部？我使用的是Spring Boot + springdoc-openapi-ui示例。在这个例子中，我希望在请求中传递不同的头。下面的配置没有显示用于选择客户标题的选项。 我还需要改变什么？ @Bean
public OpenAPI customOpenAPI(@Value("${springdoc.version}") String appVersion) {
return new OpenAPI()
.components(new Components().addSecuritySchemes("basic
浏览 36提问于2020-01-21得票数 1
回答已采纳
我有一个使用springdoc：的示例github，我不知道如何为任何api启用X转发(例如：“/person”)。
以复制步骤来再现行为：
spring=>2.2.2. version版本
springdoc=>springdoc ui的模块和版本:1.2.32
根据，我有下面的条目，并且定义了ForwardedHeaderFilter bean，
server:
forward-headers-strategy: NATIVE
示例代码：
当我单击swagger-ui.html中的-it-out时，我希望看到X转发-For报头。我看不见。
浏览 2提问于2020-07-25得票数 1
我阅读这个是为了使用springdoc webflux ui。如文档所述，我刚刚将springdoc-openapi-webflux-ui库添加到我的应用程序：implementation('org.springdoc:springdoc-openapi-webflux-ui:1.2.26')中
此外，我在application.yml中定制了API路径：
springdoc:
swagger-ui:
path: /swagger-ui.html
当我启动应用程序并转到时，它会将我重定向到。在那一页中，我发现了一个错误：
Whitelabel Error Page
浏览 6提问于2020-01-20得票数 18
您知道如何为我的应用程序名/swagger-ui添加前缀吗？smth喜欢 springdoc:
swagger-ui:
path: classpath:/META-INF/swagger-ui 但是上面的代码根本不起作用。我想访问localhost:8080/application-service/swagger-ui，而不是localhost:8080/swagger-ui (这是通过springdoc.swagger-ui.path=/swagger-ui解决的 我不想使用： server:
servlet:
context-path: /application-
浏览 356提问于2021-10-11得票数 0
我需要为Swagger使用一个特定的url。我曾经尝试过使用这个属性“sprdoc.swagger-ui.path”，但它只是重定向。
application.propperties: springdoc.swagger-ui.path=/helloWorld/swagger
浏览器中的Url：
但当点击“进入”按钮时，url将更改为以下内容：
问题是，一旦我点击enter (我需要单词“swagger”和消失)，我如何才能使路径成为或？
我现在是斯普林多克，甚至还试着和斯普林克斯合作
Pom.xml
<dependency>
<groupId>
浏览 27提问于2021-03-02得票数 0
1回答
我们正面临一个问题，在加载傲慢的ui。Out项目建立在springdoc流量之上，并与springdoc webflux ui集成.每当我们尝试加载swagger url时，spring通量都会返回部分js和css响应(swagger-ui.css，swagger-ui-bundle.js)。
请让我们知道春网通量部分响应的原因是什么。
浏览 8提问于2022-06-09得票数 0
我看了很多，但没有找到任何解决我的问题的方法:它是固定的，一种代码优先的方法将被使用，我想知道如何实现它，OpenApi (Swagger)将在我的Java / Spring应用中考虑像@Min(), @Max(), @Size(), ...这样的验证注释。每当我让generate到OpenApi文档时，这些注释就会被忽略；它们根本不会被显示出来。
目前我尝试使用
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</a
浏览 2提问于2021-08-01得票数 2
我正在尝试使用OpenAPI 3.0 (版本1.5.0)来记录REST。我的问题是如何更改swagger url以重定向到我的自定义文档？
这是我当前的application.yml文件：
api-docs:
path: /custom/api-docs
swagger-ui:
path: /custom/swagger
config-url: /custom/api-docs
如果我尝试启动我的应用程序并使用以下链接访问swagger文档：
我被重定向到
它打开了Petstore的文档，而不是我的定制文档。
如果我手动输入URL： (将configUrl更改为
浏览 3提问于2020-11-26得票数 2
我正在用我自己的API构建第三方软件的增强功能。我有第三方的用于swagger的静态.yml文件，但是对于我自己的端点，我使用springdoc注释和OpenAPI bean声明来生成文档。我能用同样的装腔作势的医生给我看一下吗？
动态生成的文档：
@Configuration
public class SwaggerConfiguration {
@Bean
public GroupedOpenApi myOpenApi() {
String group = "My Group API";
String paths[] = { "/
浏览 10提问于2022-09-12得票数 1
我正在从swagger (Open 2)转移到springdoc (Open 3)，但在某些情况下，我使用swagger-codegen-maven-plugin从yaml生成代码(为客户端和提供者)，遵循合同第一策略。下面是配置示例：
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>2.4.9</version>
<e
浏览 0提问于2020-05-08得票数 1
回答已采纳
我要从SpringFox3.0切换到OpenAPI 3.0 +Springdoc。
在Springfox中，标签顺序是字母顺序，但在Springdoc的Swagger中，顺序似乎是随机的。
如何控制UI上的标签顺序？我更喜欢自己选择的顺序，但可以按标签名称按字母顺序排序。
@Tag(name = MY_CONTROLLER_TAG_NAME, description = MY_CONTROLLER_TAG_DESC)
public class MyController {
所需的订单：
AccessTaggingTagging 分页终结点用户-Admin用户管理
实际订单：
AccessTag
浏览 68提问于2022-01-20得票数 1
回答已采纳
在提出问题之前，我通过了：，但看起来事情并不正常。
我想使用BaseLayout，也想把Open API Specification响应的主题改成黑色。
我使用的是Spring Boot v2.2.2.RELEASE和springdoc-openapi-ui V1.2.30。
# Open API Configurations
springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui-ref.html
springdoc.swagger-ui.display-request-duration=true
spr
浏览 2提问于2020-04-05得票数 0
我想通过url /v3/api-docs/设置默认方案，但有空的url和错误“没有API定义提供。”我应该使用哪些设置属性？
项目中的当前代码：
application.properties
springdoc.swagger-ui.disable-swagger-default-url=true
springdoc.swagger-ui.use-root-path=true
SwaggerConfig.java
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi applicationApi() {
浏览 24提问于2021-05-24得票数 0
我试图覆盖SpringDoc中的Swagger配置，如下所述：
我在(kotlin类) init块中设置这些代码。
init {
System.setProperty("springdoc.swagger-ui.path", "/services/$serviceName")
System.setProperty("springdoc.swagger-ui.url", "/services/$serviceName/v3/api-docs")
System.setProperty("springd
浏览 28提问于2022-02-01得票数 0
回答已采纳
我有一个简单的引导应用程序，其中添加了open swagger依赖项。
springdoc-openapi-ui
伴随着这些特性
springdoc.swagger-ui.disable-swagger-default-url=true
springdoc.swagger-ui.configUrl=/v3/api-docs/swagger-config
springdoc.swagger-ui.path=/swagger-ui.html
我得到了这些错误(当调用时)：
No API definition provided.
这是我的控制器：
@RestController
public cla
浏览 13提问于2022-03-26得票数 1
我对String和Swagger 3很陌生。如何更改默认的API描述，即Swagger springdoc-openapi-ui swagger 3中的OpenAPI definition
还有版本，开发者信息..。
我在用
implementation "org.springframework.boot:spring-boot-starter-web:2.6.6"
implementation "org.springdoc:springdoc-openapi-ui:1.6.8"
在搜索中，我只看到它们显示默认的Swagger
浏览 12提问于2022-04-28得票数 4
回答已采纳
1回答
我是springdoc的新手。我使用的是spring微服务，但我使用的是其他平台，而不是spring默认的映射注释。是否有方法告诉springs寻找其他烦恼而不是spring默认映射？或者有一种方法可以告诉spring在swagger-ui中显示一些非端点方法。
浏览 6提问于2021-12-31得票数 0
我使用MongoDB启动了一个新的Spring Boot应用程序(2.2.1.RELEASE)。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<
浏览 2提问于2019-12-09得票数 3
我希望从SpringFox库迁移到SpringDoc，以便以Open v3格式生成API文档。在我的SpringFox配置中，我禁用了默认响应消息：
@Bean
public Docket publicApi(ServletContext servletContext) {
Docket docket = new Docket(DocumentationType.SWAGGER_2)
...
.useDefaultResponseMessages(false);
但我无法在SpringDoc中找到一种方法。说“删除文档并使用application.pro
浏览 1提问于2021-03-26得票数 1
回答已采纳
我在我的spring boot应用程序中有下面的Rest函数 @SecuredMaster
@GetMapping(path = "/mitarbeiter")
@Operation(security = {@SecurityRequirement(name = "jwt")})
public Page<MitarbeiterListRow> getMitarbeiter(Pageable pageable, @RequestParam(defaultValue = "") String query) {
return mi
浏览 34提问于2019-12-20得票数 2
回答已采纳
我在用springdoc-swagger-ui。众所周知，Swagger无法处理大型响应，建议的解决方法是禁用Swagger中的语法高亮显示。
我试图为我的Spring应用程序在application.yaml中添加以下配置，但没有任何效果。我仍然看到反应是突出的。
springdoc:
swagger-ui:
syntax-highlight:
activated: false
关于如何在Swagger中禁用语法高亮显示的任何线索，请使用Springdoc或application.properties
浏览 1提问于2022-10-27得票数 0
我已经使用Java项目的pom文件中的以下构件安装了swagger-ui：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.2</version>
</dependency>
<dependency>
<groupId>org.springdoc&l
浏览 5提问于2021-01-21得票数 3
我启用了SwaggerOpenAPI3.0，如下所示：
添加下列依赖项
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.2</version>
</dependency>
<dependency>
<groupId>org.spr
浏览 3提问于2021-05-16得票数 0
Spring Boot 2.6.3与Springdoc。
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.5</version>
</dependency>
在applicaton.yaml中，当我将路径设置为/v3/api或删除它时，这
浏览 17提问于2022-01-29得票数 16
1回答
我正在使用spring boot应用程序，并希望在生成包时排除一些依赖项。这些包不应该包含在生成的war文件中：
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>0.8.8</version>
<scope>provided</scope>
浏览 0提问于2021-11-01得票数 0
对于openapi，我们使用的依赖项是pom，如下所示：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.4.1</version>
</dependency>
浏览 3提问于2020-06-19得票数 1
我正在使用springdoc-openapi-ui-1.4.3的swagger
@SecurityRequirement(name = "security_auth")
public class ProductController {}
设置安全架构
@SecurityScheme(name = "security_auth", type = SecuritySchemeType.OAUTH2,
flows = @OAuthFlows(authorizationCode = @OAuthFlow(
authoriz
浏览 8提问于2020-07-17得票数 1
我有一个Spring Boot应用程序，它使用springdoc-openapi为我的控制器生成Swagger API文档。JSON请求/响应中使用的枚举之一具有与其value/toString()不同的JSON表示。这是通过使用Jackson @JsonValue注释实现的： public enum Suit {
HEARTS("Hearts"), DIAMONDS("Diamonds"), CLUBS("Clubs"), SPADES("Spades");
@JsonValue
private fi
浏览 312提问于2021-08-11得票数 2
回答已采纳
1回答
我需要解析swagger的kotlin文档(而不是swagger注释)。
我试过，但它不起作用。
这里是我的springdoc依赖项(springdocVersion = "1.6.6")。顺便说一句，如果很重要的话，我不能使用治疗版0.13.0。
runtimeOnly("org.springdoc:springdoc-openapi-kotlin:$springdocVersion")
implementation("org.springdoc:springdoc-openapi-ui:$springdocVersion")
implemen
浏览 7提问于2022-06-24得票数 1
回答已采纳
如何更改swagger的布局？
对于布局选项，可以使用swagger配置选项。这是什么意思？
例如：
springdoc.swagger-ui.layout=BaseLayout
有哪些不同的选择可供选择？
浏览 2提问于2020-02-04得票数 2
回答已采纳
我们正在移动一个代码库，以便在springboot 2应用程序中使用Kotlin路由器DSL。目前我们将@RestController和kotlin与OpenAPI注解结合使用，效果很好。
有没有人知道OpenAPI/Swagger注解中对RouterFunctions数字用户线的支持？
我使用这个依赖项。
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
浏览 0提问于2020-01-28得票数 2
我试图使用springdoc在Swagger上提供yml文件，在文档上，它说要指定像springdoc.swagger-ui.url=/api-docs.yaml这样的文件，但是，假设我在主java文件夹中有那些yml文件，那么springdoc.swagger-ui.url应该接收什么值？
谢谢。
浏览 4提问于2020-08-14得票数 1
在我的springboot项目中，我正在使用springdoc来进行swagger集成。我在application.yml中添加了下面的属性
spring:
mvc:
pathmatch:
matching-strategy: ant_path_mathcher
并在build.gralde文件中添加了下面的依赖项
implementation "org.springdoc:springdoc-openapi-ui:1.6.9"
我能够访问/v3/api-docs，但是/swagger-ui/index.html和/swagger-ui.html提供40
浏览 8提问于2022-07-06得票数 1
回答已采纳
1回答
当将swagger-ui与使用Java7.1.0forJava11生成的反应性spring项目集成时，我添加了下面的依赖项。
应用程序具有下面的swagger依赖项。
POM依赖项
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-common</artifactId>
<version>1.4.3</version>
</dependency>
<dependency>
浏览 10提问于2022-02-16得票数 0
回答已采纳
我在我的OpenApi项目中使用SpringBoot 3来生成Swagger页面。
POM.xml中的依赖项：
<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.5.12</version> </dependency>
在Controller类中，我在方法上面定义了以下注释。
@Opera
浏览 5提问于2021-11-11得票数 0
我使用Swagger/OpenApi V3注解创建应用程序的API描述，这些注解是从以下依赖项导入的： <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.0</version>
</dependency> 我想将描述添加到每个枚举值： public enum Gender {
@Schema(descrip
浏览 1543提问于2021-07-05得票数 1
从Swagger2 2/SpringFox迁移到SpringDoc的SpringDoc没有解决如何将@ApiOperation上的response和responseContainer字段转换为新的@Operation注释。我该怎么做？
浏览 16提问于2022-07-20得票数 1
我使用的SpringBoot具有以下依赖项
<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.5.12</version> </dependency>
控制器类(@RestController)有一个入口点(@ return )，这个入口点应该返回对象的列表：MyClass.java
浏览 11提问于2021-11-01得票数 3
回答已采纳
我有一个示例SpringBoot API，它具有以下特性：
公开一个可通过GET请求调用的端点并返回自定义类( example)ContainerClass中的ContainerClass包含一个属性)的1控制器是一个抽象类，有两个子类: ChildA和ChildB。
我尝试用springdoc-openapi-maven-plugin.从这个API生成一个OpenApi契约。
在我的pom.xml中，我有以下元素：
2.2.6org.springdoc:springdoc-openapi-ui:1.4.1org.springdoc:springdoc-openapi-maven-plugin
浏览 14提问于2020-06-29得票数 4
回答已采纳
我已经在外部安装了swagger，我只是想将swagger-ui (开放源码)实例连接到openapi.yaml的localhost:8000/doc/api (openapi.yaml)。有什么想法吗？PS :我试着用
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.components(new Components().addSecuritySchemes("basicScheme",
new SecurityScheme().
浏览 3提问于2020-10-14得票数 0
回答已采纳
我还有“禁用”-problem..。 我的swagger界面url配置为/swagger-ui.html (它重定向到/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config =>which is normal！)但是默认的swagger url ( PetStore )仍然可以通过/swagger-ui/index.html访问(因此通过删除"?“中的所有内容)。 我必须解决这个问题，因为它被视为一个安全问题…… 有4种方法可以配置它，但我使用了swagger-ui yaml文件：https://swagger.
浏览 814提问于2021-04-19得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
