问题标签 [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 投票
2 回答
771 浏览

java - 使用 springdoc-openapi 和 spring-boot-starter-data-mongodb 生成 OpenAPI 文档

我已经使用 MongoDB 启动了一个新的 Spring Boot 应用程序(2.2.1.RELEASE)。

为了创建一些 API 文档,我添加了 springdoc-api:

由于我依赖 Spring 来处理 REST 端点的生成,因此我创建了这个简单的存储库:

所以我没有上课@RestController

我尝试向io.swagger.v3.oas.annotations中的方法添加一些注释ProfileRepository,但没有生成任何内容。

结果http://localhost:8080/v3/api-docs/

如何为我的 Spring Data REST 存储库端点生成 API 文档?

0 投票
2 回答
28250 浏览

swagger-2.0 - 从 Springfox Swagger 2 迁移到 Springdoc Open API

我尝试遵循这些:

https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/

如何处理如下注释:

  • @ApiModel(value = "Response container")
  • @ApiModelProperty(value = "Iventory response", required = true)
0 投票
2 回答
11828 浏览

java - springdoc-openapi 应用默认全局 SecurityScheme 可能吗?

SecurityScheme我对 java SpringBoot RESTful 应用程序使用 springdoc-openapi有以下定义:

是否可以将其全局应用于所有路径,而无需在代码中的任何@SecurityRequirement位置向注释添加注释@Operation

如果是,如何将排除项添加到不安全的路径?

0 投票
1 回答
1130 浏览

angular - Swagger-ui 将查询参数中的对象展平,但生成的角度客户端不会

我的 Spring Boot 应用程序中有以下 Rest 功能

我使用springdoc生成openapi3 yaml

生成的 yaml 看起来像这样

生成的yaml

然后我生成一个角度客户端

生成的客户端如下所示

当我使用生成的服务时,它会发出这样的请求:

错误的请求

但是当我使用招摇用户界面时,它可以正常工作

用swagger ui纠正

为什么 dies swagger-ui 发出正确的请求,但生成的 angular-client 没有?

0 投票
2 回答
9550 浏览

java - java.lang.IllegalStateException:在使用 Spring Boot 实现开放 API 时无法读取类的元数据

我正在尝试在 Spring Boot 中使用 Spring实现Open API DocOpen API UI :

我指的是以下指南: https ://www.baeldung.com/spring-rest-openapi-documentation

maven中的依赖如下:

我使用的 Spring Boot 版本是 2.2

通过运行应用程序时出现以下与元数据相关的错误./mvnw spring-boot:run

任何线索为什么会发生?

0 投票
1 回答
804 浏览

swagger - 使用 springdoc-openapi 接受标头的默认值

我正在使用 springdoc-openapi 库来自动生成和渲染 swagger-ui。我需要为接受标头添加默认值。这个怎么做?

springfox 允许使用 ParameterBuilder 的 defaultValue 函数来做到这一点。附上截图。我想在不使用 springfox 的情况下达到同样的效果。

在此处输入图像描述

0 投票
2 回答
3730 浏览

swagger - springdoc-openapi 规范生成与泛型继承

我有一个 Spring Boot (kotlin) 项目,我使用 springdoc-openapi 生成 OpenApi 3 规范。我的数据模型如下所示:

和一个像这样的简单控制器:

生成的 yaml 是:

这里的问题是我的控制器可以返回DogFoodor CatFood,并且在返回类型中指定。我希望生成的架构是:

有没有办法做到这一点?

0 投票
1 回答
8391 浏览

java - 如何使用 springdoc-openapi-webflux-ui 显示应用程序 API 文档?

我读了这个https://springdoc.org/demos.html来使用 springdoc-openapi-webflux-ui。正如文档所说,我刚刚将springdoc-openapi-webflux-ui库添加到我的应用程序中:implementation('org.springdoc:springdoc-openapi-webflux-ui:1.2.26')

此外,我在 application.yml 中自定义了 API 的路径:

当我启动应用程序并转到 http://localhost:8080/swagger-ui.html 时,它会将我重定向到 http://localhost:8080/webjars/swagger-ui/index.html?configUrl=/v3/api -文档/招摇配置。在那个页面中,我收到了一个错误:

问题是:我应该向我的应用程序添加其他配置以显示 API 文档吗?

PS:我使用 spring.boot 2.2.2:RELEASE

0 投票
1 回答
2369 浏览

spring - 无法在 Open API UI 中显示自定义标题

使用 Open API 3 时如何设置自定义标题?我正在使用 Spring Boot + springdoc-openapi-ui 示例。在此示例中,我希望在请求中传递不同的标头。以下配置不显示选择客户标题的选项。

我还需要改变什么?

0 投票
5 回答
7579 浏览

java - 如何使用 springdoc-openapi 将 Open API 3 与 Spring 项目(不是 Spring Boot)集成

我现有的项目是在 Spring Framework 而不是 Spring Boot 上。

我想将 Open API 3 与它集成。

我想使用 springdoc-openapi 集成而不是使用 Jersey。