问题标签 [springdoc-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 回答
2984 浏览

spring - 如何从 Open API 3 规范全局忽略 Spring Boot 的 API?

我已经浏览了文档:https ://springdoc.github.io/springdoc-openapi-demos/faq.html#how-can-i-ignore-some-field-of-model- ,但是文档不是很清楚,我有Spring Boot REST HATEOAS实现项目并使用Open API 3 规范而不是 Swagger

我已经为每个端点实现了分页,但是我的行业标准如何期望内容作为复数内容。但由于这是 Pageable API 的一部分,我无法覆盖它,而是希望禁用它。有什么建议我们该怎么做?

就像在 Springfox Swagger 中一样,我们可以像下面那样做,在Open API 3 (springdoc-openui)中它的等价物是什么 ?

这是我的终点

0 投票
1 回答
712 浏览

spring - Springdoc Open API UI - BaseLayout 不起作用

在提出问题之前,我经历了:https : //springdoc.org/springdoc-properties.html#springdoc-openapi-core-properties,但看起来事情不正常。

我想使用 BaseLayout 并且还想将 Open API Specification 响应的主题更改为黑色。

我正在使用Spring Boot v2.2.2.RELEASEspringdoc-openapi-ui V1.2.30

即使进行了上述配置,默认配置也不会生效。

0 投票
1 回答
1253 浏览

spring - 将 Actuator 添加为 groupedOpenApi

我们可以将 Actuator 端点添加为一个 groupedOpenApi 吗?

前任 :

谢谢

0 投票
1 回答
505 浏览

spring-boot - 如何根据用户从 swagger UI 中的主机列表中选择“主机”来定义将生成“绝对”身份验证 URL 的 tokenURL?

我有一个 Spring Boot 应用程序,我正在尝试为其生成开放 API 3.0 文档,为此我正在使用 springdoc lib。我正在使用注释来记录应用程序的不同部分,最后我想自动生成文档。我正在为所有文档使用注释,并且发现从 springdocs 的官方文档中复制 yaml/json 中列出的类似内容有点困难。我有多个应用程序实例,并将所有这些实例的文档上传到一个开放的 API UI。对于多个主机,我已将它们定义如下:

现在对我来说的问题是,toeken URL 像上面定义的那样显示,我想定义绝对 URL,它将根据用户选择进行更新。例如 - https://server-3.com/v1/authenticate。我怎样才能在注释中做到这一点?

0 投票
2 回答
6056 浏览

swagger - Springdoc OpenAPI ui 不遵守“位置”中的上下文路径

设置:

我正在使用springdoc-openapi-ui1.4.0 版(通过 Maven)中的 Java 库,而在一个简单的 spring-boot 项目中没有任何自定义。

Swagger 页面在 https://my-url.com/my-context-path/swagger-ui/index.html下生成

以及https://my-url.com/my-context-path/v3/api-docs/下的 api-docs

这两项工作,我可以达到他们。到目前为止,一切都很好!

现在的问题:

当简单地导航到https://my-url.com/my-context-path/swagger-ui.html我得到一个 HTTP 状态 302 和一个location在响应标头中设置的属性,该属性应该将我重定向到招摇页面从上面(我假设)。

但是,location属性中的 URL 错过了上下文路径!它看起来像这样: https ://my-url.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

它重定向到一个不存在的页面,我收到 404 错误代码。请注意,configUrl 似乎也缺少上下文路径。

任何想法为什么会发生这种情况以及如何解决?

这个 Github 问题似乎是同样的问题,但最后指出问题已得到解决:https ://github.com/springdoc/springdoc-openapi/issues/37这是我之前的版本。

0 投票
1 回答
870 浏览

springdoc - 如何在 Spring Boot 和 Spring doc 中隐藏基于 Profiles 的端点?

我正在研究Spring Boot v2.2.2.RELEASE and SpringDoc UI and Open API Specification OAS3,我在这里发现了非常相关的问题:https ://github.com/springdoc/springdoc-openapi/issues/201 。

我有 4 个配置文件,分别是 Dev、Stage、UAT 和 Prod,并说我有 Student API、Employee API 和 Department API。

我想要 UAT 和 Prod 配置文件,我想隐藏部门 API。我们怎么能不呢?

0 投票
1 回答
3574 浏览

swagger-ui - 如何在 Swagger-ui SpringDoc open ui 上对 Schemas 进行排序

我想对我Schemas为我的实体类生成的 DTO 类进行排序Springdoc ui
我可以通过文件中的以下配置对tagsand进行排序,但我的模式未按排序顺序。operationsyml

我怎么能对我的模式进行排序。
谢谢。

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

swagger - 如何使用springdoc更改swagger授权屏幕上的文本

我想更改 swagger 授权 UI 屏幕上显示的文本。

我想将Authorized标签更改为Stored

请从 swagger UI 授权屏幕中找到以下屏幕截图

在此处输入图像描述

我想改变它的原因是错过领先。如果用户传递的凭据仍然无效,则它仍显示为已授权。

一旦我们执行请求,用户名和密码的实际验证就会发生。

一旦我们按下授权按钮,如果有人回答验证凭据,我也很好,如下所示。

Note: I am using Spring-boot, Spring security, and springdoc

在此处输入图像描述

任何想法或想法将不胜感激

谢谢 !!

0 投票
1 回答
802 浏览

springdoc - 具有多个 api-docs 的 Springdoc

我想在一个 swagger-ui 中组合三个 API 文档。我使用 Springdoc。三个 API 文档中的每一个都有自己的 url。(他们不在同一个项目中)。有没有办法做到这一点?

编辑:它现在以这种方式工作: