嵌套复杂类型中的SpringDoc swagger文档生成异常

文章/答案/技术大牛

发布

1回答

swagger、springdoc、springdoc-openapi-ui

Person类有一个类型为PersonDetail的属性。并且PersonDetail有一个类型为Mail class的属性。当我们启动应用程序并导航到swagger ui html页面时，在openapi定义的组件部分中没有生成Mail类，并且我们在页面上得到了“无法解析引用:无法解析指针:/组件/架构/邮件不存在于文档中”正如我们检查的那样，如果在第三层中<

浏览 144提问于2020-05-20得票数 1

1回答

springdoc嵌套端点未被拾取

spring-boot、swagger、openapi、springdoc、springdoc-openapi-ui

我正在使用springdoc 1.6.11，并且我发现我的控制器中的嵌套端点不会在Swagger文档中被捕获。但是生成的Swagger并没有捡到它。license(new Li

浏览 12提问于2022-09-17得票数 0

2回答

Spring open api -如何使用java config读取外部swagger* api文档*

spring-boot、springdoc-openapi-ui

在我的春季引导应用程序中，在应用程序启动时，我正在生成多个json格式的swagger文档，并存储在位置-静态/标记文件。swaggerdoc/openapi.json<em

浏览 6提问于2022-01-26得票数 1

回答已采纳

2回答

从Springfox Swagger* 2迁移到Springdoc开放API*

swagger-2.0、openapi、springdoc

我试着遵循这些：

浏览 2提问于2019-12-11得票数 54

回答已采纳

2回答

如何为springdoc* swagger-ui HTML页面配置自定义URL？*

spring、springdoc、springdoc-openapi-ui

将springdoc依赖项添加到我的Spring项目(而不是springdoc)之后，将生成OpenAPI V3文档，并可以使用默认的swagger页面：localhost:8080/swagger-ui.html因为springdoc文档取代了以前的Swagger文档，所以我希望在相同的URL localhost:8080/

浏览 3提问于2021-07-21得票数 2

1回答

而不是POSTing JSON

spring-boot、swagger、springdoc-openapi-ui

我有一个springdoc应用程序，它使用支持Swagger。对于我来说，我无法让生成的Swagger实际发布JSON。相反，前端将args作为请求参数传递。如何让Swagger真正提交JSON？UI中单击“尝试它”和“执行”之后，请求将失败： "status": 415, ...因为UI试图发布以下内容info=tes

浏览 8提问于2022-01-28得票数 3

回答已采纳

1回答

在springdoc中，是否可以在同一组中显示OpenAPI生成的UI和自定义静态yml文件的UI？

java、spring-boot、swagger、springdoc

我正在用我自己的API构建第三方软件的增强功能。我有第三方的用于swagger的静态.yml文件，但是对于我自己的端点，我使用springdoc注释和OpenAPI bean声明来生成文档。动态生成的文档：public class SwaggerConfiguration { public GroupedOpenApi myO

浏览 10提问于2022-09-12得票数 1

1回答

禁用默认响应按摩SpringDoc* Open 3*

swagger、openapi、springdoc

我希望从SpringFox库迁移到SpringDoc，以便以Open v3格式生成API文档。在我的SpringFox配置中，我禁用了默认响应消息：public Docket publicApi(ServletContext servletContext) { ... .useDefaultResponseMessages(f

浏览 1提问于2021-03-26得票数 1

回答已采纳

1回答

嵌套类的OpenAPI 3.0Java注解

java、openapi、openapi-generator、springdoc

在使用Java3.0Java注解时，我正在尝试让组件看起来像是嵌套在一起的。但是，在另一个对象中引用的每个对象都被创建为$ref，而不是构建为该字段节点。没有$ref，我怎么才能让它嵌套在下面呢？

浏览 9提问于2020-09-05得票数 0

1回答

健康检查生成的HealthReport对象结构端点冻结Swagger页面

c#、.net-core、asp.net-core-webapi、.net-5

applicationBuilder.UseHealthChecks("/health"); }不幸的是，健康端点没有出现在swagger文档中。HttpStatusCode.ServiceUnavailable; return StatusCode(serviceUnavailableStatusCode, healthReport);} 在运行应用程序时，Swagger

浏览 2提问于2021-05-28得票数 4

回答已采纳

1回答

将对象转换为多查询参数Swagger

java、spring-boot、swagger、springdoc-openapi-ui

我正在尝试从一个对象生成带有查询参数的swagger文档，但我不确定springdoc是否可能。我知道这在io.springfox中是可能的。我想要的是创建一个单独的对象，将所有字段添加到这个对象中，然后将这些字段作为单独的查询参数显示在swagger文档中。例如测试用例：用于下列代码：生成了以下傲慢的

浏览 6提问于2022-10-20得票数 0

回答已采纳

2回答

无法使用spring boot加载Swagger-UI

spring-boot、swagger、swagger-ui、swagger-2.0、springfox

我正在尝试使用Swagger动态记录我的SpringBoot应用程序的REST API。这是我的设置：<?>springfox-swagger2</artifactId> <ver

浏览 2提问于2017-09-04得票数 3

2回答

如何从现有的Spring生成OpenAPI 3.0 YAML文件？

spring、spring-boot、yaml、swagger、openapi

我有一个现有的Spring，我想为它生成OpenAPI 3.0 YAML文件，而不是Swagger2.0JSON/YAML？此外，还有，但它似乎不支持Spring。url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "exampl

浏览 0提问于2019-02-28得票数 26

回答已采纳

3回答

在springdoc中使用openapi.yaml

swagger、springdoc

我可以从OpenAPI中自定义。我用一个@RestController创建了一个简单的springboot项目。但我在打开的swagger页面上看到了默认值。

浏览 17提问于2020-05-29得票数 4

回答已采纳

1回答

Openapi codegen by gradle插件: UI不能正确显示

spring-boot、swagger-ui、openapi

我正在尝试通过gradle插件测试openapi代码生成器。所以，我有一个包含文档的.yml文件(在中运行它，看起来很酷)info: version: 1.0.0 -:springdoc-openapi-ui:1.5.2' implemen

浏览 18提问于2021-02-19得票数 0

回答已采纳

1回答

使用OpenAPI插件在编译时从Spring应用程序源生成maven 3.0JSON/yaml

java、spring、maven、swagger

我希望在编译时使用OpenApi插件从现有的Spring3.0(注意:不是引导)应用程序源中生成一个Spring3.0定义。我在控制器类中设置了io.swagger.v3.oas.annotations，如下所示： import io.swagger.v3.oas.annotations.Operation和/或io.swagger.v3.oas.integration.api.OpenApiScanner实现来实际获取相关的注释

浏览 11提问于2022-06-22得票数 2

3回答

如何让springdoc-openapi在不更改toString的情况下使用@JsonValue枚举格式？

java、jackson、swagger、springdoc、springdoc-openapi-ui

我有一个Spring Boot应用程序，它使用springdoc-openapi为我的控制器生成Swagger API文档。private final String jsonValue; } 但是，在列出枚举值时，生成的Swagger API文档使用枚举值(具体地说，是toString()的值)，而

浏览 312提问于2021-08-11得票数 2

回答已采纳

1回答

Springdoc忽略"is“是"isSelected”等属性的前缀

java、springdoc

使用默认的springdoc配置为我的spring引导应用程序生成swagger。我们在api请求和响应中使用" is“前缀pro属性，但是在生成的api文档中没有"is”前缀。selected: valid:是否有任何不可忽略的配置" Is“前缀为

浏览 2提问于2020-03-13得票数 1

回答已采纳

3回答

为HttpServletRequest使用Swagger文档

java、spring-boot、servlets、swagger、swagger-codegen

我刚开始自吹自擂，并使用它的文档。我目前正在尝试使用swagger来显示补丁请求的请求体。以前，补丁方法的参数是正在更新的对象的DTO，这使得显示对象的属性变得非常容易(因为我正在使用SpringBoot，并且使用@Schema非常完美)。但是，现在这个补丁方法的参数是一个HttpServletRequest。我不想在swagger中显示HttpServletRequest (这似乎是自动发生<em

浏览 15提问于2020-07-13得票数 1

回答已采纳

1回答

一种基于条件的springdoc隐藏方法

spring-boot、spring-boot-actuator、springdoc-openapi-ui、springdoc-ui

我们正在开发一个spring引导项目，该项目使用springdoc库来生成swagger文档。我们有一个需求，需要在控制器中隐藏一些API。Spring引导提供了一种使用@ConditionalOnProperty标记隐藏/显示控制器的方法。但是spring引导没有一种方法可以隐藏/显示基于属性的方法。springdoc提供了一种在扫描所有控制器后过滤操作的方法吗？或基于属性在swagger上隐藏

浏览 33提问于2021-12-07得票数 1

点击加载更多