问题标签 [springdoc-openapi-ui]

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 回答
1265 浏览

java - WebFlux Swagger (Open API) 集成 - 发布请求示例

我已经将 Swagger (OpenAPI) 与 Spring Webflux 集成在一起,如下所述:https : //springdoc.org/#spring-weblfuxwebmvcfn-with-functional-endpoints using RouterOperation。集成工作正常,可在 /swagger-ui.html 访问

但是,对于 POST API,当我单击“试用”按钮时,我没有看到“请求”示例。我的 Post API 接受 Json 作为请求正文。

我该如何配置?这可以通过注释以及 RouterOperation 或其他东西来完成吗?

编辑:下面是我的路由器类代码:

添加 RouterOperations 注释后,我可以看到 swagger-ui 正确显示了 GET 和 POST API,但没有显示请求模式示例。

我还遇到了 yaml / json 文件来描述这一点。但是我没有找到将该文件放在我的应用程序中的位置,以便 swagger-ui 使用它。

0 投票
1 回答
94 浏览

java - springdoc-openapi-ui生成的swagger-ui中如何更改请求头中授权key的名称

我的 OpenAPI 配置

我需要将标头密钥从授权更改为 Authorization-internal

生成的图像

0 投票
2 回答
734 浏览

spring-boot - 当我在 swagger-ui.html 中单击“试用”时,X-Forwarded-For 未出现

我有一个使用 springdoc 的示例 github:https ://github.com/vmisra2018/sb-example-swaggerdoc 我不知道如何为任何 api 启用 X-Forwarded-For 例如:“/person” 当我点击试用

重现行为的重现 步骤:

spring-boot 的版本=> 2.2.2.RELEASE

springdoc-openapi 的模块和版本 => springdoc-openapi-ui:1.2.32

我根据https://springdoc.org/faq.html有以下条目,并且还定义了 ForwardedHeaderFilter bean,

示例代码: https ://github.com/vmisra2018/sb-example-swaggerdoc

预期的行为 当我单击 swagger-ui.html 中的 try-it-out 时,我希望看到 X-Forwarded-For 标头。我没看到。

0 投票
4 回答
10530 浏览

swagger-ui - 在 SpringDoc OpenAPi 中未禁用 petstore URL

我正在使用SpringDoc 1.4.3招摇。
我添加了以下配置以禁用petstoreURLapplication.yml

配置

但是当我在探索文本框中点击https://petstore.swagger.io/v2/swagger.json时,它仍然向我显示 petsore URL,如下图所示。

大摇大摆的形象

大摇大摆的形象

0 投票
1 回答
4128 浏览

java - Spring Doc swagger API 上的日期格式时间

我正在尝试使用 spring doc 从我的 springboot 应用程序生成文档,这是导致我出现问题的类的一些属性:

使用 Spring doc 注释,我大摇大摆地得到了这个:

dateOfBirth* 字符串($日期时间)

“出生日期”:“2020-04-29T14:15:32.475Z”

虽然我想要这个:

dateOfBirth* 字符串($date)

“出生日期”:“2020-04-29”

怎么做?我认为接近解决方案,但我无法弄清楚我所缺少的

0 投票
1 回答
1079 浏览

spring-boot - Spring-Doc open api不适用于Spring云配置服务器@EnableConfigServer

spring boot 2.3.2.RELEASEspring-cloud-config-server 2.2.4.RELEASE. 我试图spring-doc-openapi (1.4.3)在现有项目中实施。如果我添加@EnableConfigServer一个配置类文件,swagger-ui.html端点会返回一个奇怪的 json:

而不是预期的招摇用户界面。我不确定它是否是一个错误,但希望能提供任何帮助。

0 投票
2 回答
1161 浏览

java - OpenAPI3 通过 Spring Boot 显示基于基本身份验证的方法

我将此依赖项添加到我的 Spring Boot 应用程序中

然后我能够打开: https://localhost:8443/v3/api-docs

浏览器确实会询问我的凭据,只要我输入正确的用户/密码,它就可以工作,但它会向我显示全球可用的所有方法。我只希望用户有权使用的方法显示在 api 文档中。

对于一个特定的方法是使用这个标签来授权我的调用: @PreAuthorize("hasRole('USER') OR hasRole('ADMIN')")

这是我的网络安全配置类:

0 投票
1 回答
278 浏览

spring-boot - 如何使用 Spring Boot 在 OpenAPI UI 中显示 Json

我正在尝试使用 openAPI 3.0 实现集中式招摇,但我面临以下问题:

  1. 我能够从所有微服务中获取所有 openApi json 并添加 concurrentHaspMap。

serviceDescriptions = new ConcurrentHashMap<String, String>(); serviceDescriptions.put(serviceName, serviceDescription);

在 serviceDescriptions 我有所有 OpenAPI Json。

  1. 如何在 OpenAPI UI 中显示这个 Json?请帮我在 OpenApi UI 中显示。
0 投票
2 回答
1045 浏览

openapi - springdoc 使用@ApiResponse(java注释)的多个404响应

如何使用 java 注释创建多个 404 响应(或更广泛地说,多个相同的 HTTP 代码响应)。

我试过了:

还有多个@Content

我可以获得类似于 multiple 的唯一方法是使用@ExampleObject[]

并不理想,因为它需要人工交互才能查看所有这些,而且是不想要的;期望是:

甚至更好:

我正在使用 springdoc 和以下 dep:

0 投票
1 回答
533 浏览

swagger-ui - Springdoc OpenAPI UI 文档

是否可以使用接口而不是实现这些接口的控制器类来生成 swagger ui 文档?

将文档放在实现类中会使它看起来杂乱无章。Springfox 有这个选项,它在 springdoc 中可用吗?如果是这样,该怎么做?